Skip to content

Commit

Permalink
Update javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Auto Mation committed Nov 8, 2023
1 parent ba69c1a commit c306781
Show file tree
Hide file tree
Showing 240 changed files with 2,405 additions and 1,304 deletions.
22 changes: 13 additions & 9 deletions javadoc/allclasses-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19890,29 +19890,33 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
Example to create an instance using the builder pattern
</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/message/MessagePagedQueryResponse.html" title="interface in com.commercetools.api.models.message">MessagePagedQueryResponse</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/subscription/MessageDeliveryPayloadMixin.html" title="interface in com.commercetools.api.models.subscription">MessageDeliveryPayloadMixin</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/message/MessagePagedQueryResponse.html" title="interface in com.commercetools.api.models.message">MessagePagedQueryResponse</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
<div class="block">PagedQueryResult with <code>results</code> containing an array of Message.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/commercetools/api/models/message/MessagePagedQueryResponseBuilder.html" title="class in com.commercetools.api.models.message">MessagePagedQueryResponseBuilder</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/commercetools/api/models/message/MessagePagedQueryResponseBuilder.html" title="class in com.commercetools.api.models.message">MessagePagedQueryResponseBuilder</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">MessagePagedQueryResponseBuilder

Example to create an instance using the builder pattern
</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/message/MessagePayload.html" title="interface in com.commercetools.api.models.message">MessagePayload</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/message/MessagePayload.html" title="interface in com.commercetools.api.models.message">MessagePayload</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
<div class="block">MessagePayload


Example to create a subtype instance using the builder pattern
</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/commercetools/api/models/message/MessagePayloadBuilder.html" title="class in com.commercetools.api.models.message">MessagePayloadBuilder</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/commercetools/api/models/message/MessagePayloadBuilder.html" title="class in com.commercetools.api.models.message">MessagePayloadBuilder</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">MessagePayloadBuilder</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/message/MessagePayloadMixin.html" title="interface in com.commercetools.api.models.message">MessagePayloadMixin</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/message/MessagesConfiguration.html" title="interface in com.commercetools.api.models.message">MessagesConfiguration</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">Holds the configuration for the Messages Query feature for the Project.</div>
Expand Down Expand Up @@ -31235,7 +31239,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/commercetools/docs/meta/Serialization.html" title="class in com.commercetools.docs.meta">Serialization</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block"><b>Table of content</b><ul><li>Serialization</li><ul><li><a href="#customization">Customization</a></li><li><a href="#date-time-attributes">Date and time attributes</a></li><li><a href="#JsonNodes">Use JsonNodes</a></li></ul></ul></div>
<div class="block"><b>Table of content</b><ul><li>Serialization</li><ul><li><a href="#customization">Customization</a></li><li><a href="#date-time-attributes">Date and time attributes</a></li><li><a href="#number-attributes">Number attributes</a></li><li><a href="#JsonNodes">Deserialize Attributes as JsonNode</a></li></ul></ul></div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="io/vrap/rmf/base/client/SerializationException.html" title="class in io.vrap.rmf.base.client">SerializationException</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">&nbsp;</div>
Expand Down
76 changes: 73 additions & 3 deletions javadoc/com/commercetools/api/json/ApiModuleOptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,13 @@ <h2>Field Summary</h2>
<div class="col-second even-row-color"><code><a href="#DESERIALIZE_ATTRIBUTE_AS_JSON_NODE" class="member-name-link">DESERIALIZE_ATTRIBUTE_AS_JSON_NODE</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#DESERIALIZE_CUSTOM_FIELD_AS_JSON_NODE" class="member-name-link">DESERIALIZE_CUSTOM_FIELD_AS_JSON_NODE</a></code></div>
<div class="col-second odd-row-color"><code><a href="#DESERIALIZE_ATTRIBUTE_NUMBER_AS_DOUBLE" class="member-name-link">DESERIALIZE_ATTRIBUTE_NUMBER_AS_DOUBLE</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#DESERIALIZE_CUSTOM_FIELD_AS_JSON_NODE" class="member-name-link">DESERIALIZE_CUSTOM_FIELD_AS_JSON_NODE</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#DESERIALIZE_CUSTOM_FIELD_NUMBER_AS_DOUBLE" class="member-name-link">DESERIALIZE_CUSTOM_FIELD_NUMBER_AS_DOUBLE</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#DESERIALIZE_DATE_ATTRIBUTE_AS_STRING" class="member-name-link">DESERIALIZE_DATE_ATTRIBUTE_AS_STRING</a></code></div>
Expand All @@ -124,7 +130,13 @@ <h2>Method Summary</h2>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAttributeAsJsonNode()" class="member-name-link">getAttributeAsJsonNode</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCustomFieldAsJsonNode()" class="member-name-link">getCustomFieldAsJsonNode</a>()</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAttributeNumberAsDouble()" class="member-name-link">getAttributeNumberAsDouble</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCustomFieldAsJsonNode()" class="member-name-link">getCustomFieldAsJsonNode</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCustomFieldNumberAsDouble()" class="member-name-link">getCustomFieldNumberAsDouble</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDateAttributeAsString()" class="member-name-link">getDateAttributeAsString</a>()</code></div>
Expand All @@ -142,7 +154,13 @@ <h2>Method Summary</h2>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withAttributeAsJsonNode(java.lang.Boolean)" class="member-name-link">withAttributeAsJsonNode</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&nbsp;attributeAsJsonNode)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ApiModuleOptions.html" title="class in com.commercetools.api.json">ApiModuleOptions</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withCustomFieldAsJsonNode(java.lang.Boolean)" class="member-name-link">withCustomFieldAsJsonNode</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&nbsp;customFieldAsJsonNode)</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withAttributeNumberAsDouble(java.lang.Boolean)" class="member-name-link">withAttributeNumberAsDouble</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&nbsp;attributeNumberAsDouble)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ApiModuleOptions.html" title="class in com.commercetools.api.json">ApiModuleOptions</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withCustomFieldAsJsonNode(java.lang.Boolean)" class="member-name-link">withCustomFieldAsJsonNode</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&nbsp;customFieldAsJsonNode)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ApiModuleOptions.html" title="class in com.commercetools.api.json">ApiModuleOptions</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withCustomFieldNumberAsDouble(java.lang.Boolean)" class="member-name-link">withCustomFieldNumberAsDouble</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&nbsp;customFieldNumberAsDouble)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ApiModuleOptions.html" title="class in com.commercetools.api.json">ApiModuleOptions</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withDateAttributeAsString(java.lang.Boolean)" class="member-name-link">withDateAttributeAsString</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&nbsp;dateAttributeAsString)</code></div>
Expand Down Expand Up @@ -223,6 +241,34 @@ <h3>DESERIALIZE_CUSTOM_FIELD_AS_JSON_NODE</h3>
</dl>
</section>
</li>
<li>
<section class="detail" id="DESERIALIZE_CUSTOM_FIELD_NUMBER_AS_DOUBLE">
<h3>DESERIALIZE_CUSTOM_FIELD_NUMBER_AS_DOUBLE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">DESERIALIZE_CUSTOM_FIELD_NUMBER_AS_DOUBLE</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../constant-values.html#com.commercetools.api.json.ApiModuleOptions.DESERIALIZE_CUSTOM_FIELD_NUMBER_AS_DOUBLE">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="DESERIALIZE_ATTRIBUTE_NUMBER_AS_DOUBLE">
<h3>DESERIALIZE_ATTRIBUTE_NUMBER_AS_DOUBLE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">DESERIALIZE_ATTRIBUTE_NUMBER_AS_DOUBLE</span></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../constant-values.html#com.commercetools.api.json.ApiModuleOptions.DESERIALIZE_ATTRIBUTE_NUMBER_AS_DOUBLE">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
Expand Down Expand Up @@ -262,6 +308,18 @@ <h3>getCustomFieldAsJsonNode</h3>
</section>
</li>
<li>
<section class="detail" id="getAttributeNumberAsDouble()">
<h3>getAttributeNumberAsDouble</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></span>&nbsp;<span class="element-name">getAttributeNumberAsDouble</span>()</div>
</section>
</li>
<li>
<section class="detail" id="getCustomFieldNumberAsDouble()">
<h3>getCustomFieldNumberAsDouble</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></span>&nbsp;<span class="element-name">getCustomFieldNumberAsDouble</span>()</div>
</section>
</li>
<li>
<section class="detail" id="withDateCustomFieldAsString(java.lang.Boolean)">
<h3>withDateCustomFieldAsString</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ApiModuleOptions.html" title="class in com.commercetools.api.json">ApiModuleOptions</a></span>&nbsp;<span class="element-name">withDateCustomFieldAsString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&nbsp;dateCustomFieldAsString)</span></div>
Expand All @@ -286,6 +344,18 @@ <h3>withCustomFieldAsJsonNode</h3>
</section>
</li>
<li>
<section class="detail" id="withCustomFieldNumberAsDouble(java.lang.Boolean)">
<h3>withCustomFieldNumberAsDouble</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ApiModuleOptions.html" title="class in com.commercetools.api.json">ApiModuleOptions</a></span>&nbsp;<span class="element-name">withCustomFieldNumberAsDouble</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&nbsp;customFieldNumberAsDouble)</span></div>
</section>
</li>
<li>
<section class="detail" id="withAttributeNumberAsDouble(java.lang.Boolean)">
<h3>withAttributeNumberAsDouble</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ApiModuleOptions.html" title="class in com.commercetools.api.json">ApiModuleOptions</a></span>&nbsp;<span class="element-name">withAttributeNumberAsDouble</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&nbsp;attributeNumberAsDouble)</span></div>
</section>
</li>
<li>
<section class="detail" id="getOption(java.lang.String)">
<h3>getOption</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getOption</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
Expand Down
Loading

0 comments on commit c306781

Please sign in to comment.