Skip to content

Commit

Permalink
Update javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Auto Mation committed Dec 4, 2023
1 parent 594a62c commit 2df9682
Show file tree
Hide file tree
Showing 62 changed files with 2,243 additions and 2,229 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ <h1 title="Interface AssociateRoleResourceIdentifier" class="title">Interface As
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">AssociateRoleResourceIdentifier</span><span class="extends-implements">
extends <a href="../common/ResourceIdentifier.html" title="interface in com.commercetools.api.models.common">ResourceIdentifier</a>, <a href="../Identifiable.html" title="interface in com.commercetools.api.models">Identifiable</a>&lt;<a href="AssociateRole.html" title="interface in com.commercetools.api.models.associate_role">AssociateRole</a>&gt;</span></div>
<div class="block"><p>ResourceIdentifier of an AssociateRole.</p>
<div class="block"><p>ResourceIdentifier of an AssociateRole. Either <code>id</code> or <code>key</code> is required. If both are set, an InvalidJsonInput error is returned.</p>

<hr>
Example to create an instance using the builder pattern
Expand Down Expand Up @@ -218,7 +218,7 @@ <h2>Method Details</h2>
<section class="detail" id="getId()">
<h3>getId</h3>
<div class="member-signature"><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">getId</span>()</div>
<div class="block"><p>Unique identifier of the referenced AssociateRole. Either <code>id</code> or <code>key</code> is required.</p></div>
<div class="block"><p>Unique identifier of the referenced AssociateRole. Required if <code>key</code> is absent.</p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Identifiable.html#getId()">getId</a></code>&nbsp;in interface&nbsp;<code><a href="../Identifiable.html" title="interface in com.commercetools.api.models">Identifiable</a>&lt;<a href="AssociateRole.html" title="interface in com.commercetools.api.models.associate_role">AssociateRole</a>&gt;</code></dd>
Expand All @@ -233,7 +233,7 @@ <h3>getId</h3>
<section class="detail" id="getKey()">
<h3>getKey</h3>
<div class="member-signature"><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">getKey</span>()</div>
<div class="block"><p>Unique key of the referenced AssociateRole. Either <code>id</code> or <code>key</code> is required.</p></div>
<div class="block"><p>Unique key of the referenced AssociateRole. Required if <code>id</code> is absent.</p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../common/ResourceIdentifier.html#getKey()">getKey</a></code>&nbsp;in interface&nbsp;<code><a href="../common/ResourceIdentifier.html" title="interface in com.commercetools.api.models.common">ResourceIdentifier</a></code></dd>
Expand All @@ -248,7 +248,7 @@ <h3>getKey</h3>
<section class="detail" id="setId(java.lang.String)">
<h3>setId</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setId</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;id)</span></div>
<div class="block"><p>Unique identifier of the referenced AssociateRole. Either <code>id</code> or <code>key</code> is required.</p></div>
<div class="block"><p>Unique identifier of the referenced AssociateRole. Required if <code>key</code> is absent.</p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../common/ResourceIdentifier.html#setId(java.lang.String)">setId</a></code>&nbsp;in interface&nbsp;<code><a href="../common/ResourceIdentifier.html" title="interface in com.commercetools.api.models.common">ResourceIdentifier</a></code></dd>
Expand All @@ -261,7 +261,7 @@ <h3>setId</h3>
<section class="detail" id="setKey(java.lang.String)">
<h3>setKey</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setKey</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;key)</span></div>
<div class="block"><p>Unique key of the referenced AssociateRole. Either <code>id</code> or <code>key</code> is required.</p></div>
<div class="block"><p>Unique key of the referenced AssociateRole. Required if <code>id</code> is absent.</p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../common/ResourceIdentifier.html#setKey(java.lang.String)">setKey</a></code>&nbsp;in interface&nbsp;<code><a href="../common/ResourceIdentifier.html" title="interface in com.commercetools.api.models.common">ResourceIdentifier</a></code></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ <h2>Method Details</h2>
<h3>id</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AssociateRoleResourceIdentifierBuilder.html" title="class in com.commercetools.api.models.associate_role">AssociateRoleResourceIdentifierBuilder</a></span>&nbsp;<span class="element-name">id</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html" title="class or interface in javax.annotation" class="external-link">@Nullable</a>
<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;id)</span></div>
<div class="block"><p>Unique identifier of the referenced AssociateRole. Either <code>id</code> or <code>key</code> is required.</p></div>
<div class="block"><p>Unique identifier of the referenced AssociateRole. Required if <code>key</code> is absent.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>id</code> - value to be set</dd>
Expand All @@ -208,7 +208,7 @@ <h3>id</h3>
<h3>key</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AssociateRoleResourceIdentifierBuilder.html" title="class in com.commercetools.api.models.associate_role">AssociateRoleResourceIdentifierBuilder</a></span>&nbsp;<span class="element-name">key</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html" title="class or interface in javax.annotation" class="external-link">@Nullable</a>
<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;key)</span></div>
<div class="block"><p>Unique key of the referenced AssociateRole. Either <code>id</code> or <code>key</code> is required.</p></div>
<div class="block"><p>Unique key of the referenced AssociateRole. Required if <code>id</code> is absent.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - value to be set</dd>
Expand All @@ -222,7 +222,7 @@ <h3>key</h3>
<h3>getId</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html" title="class or interface in javax.annotation" class="external-link">@Nullable</a>
</span><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">getId</span>()</div>
<div class="block"><p>Unique identifier of the referenced AssociateRole. Either <code>id</code> or <code>key</code> is required.</p></div>
<div class="block"><p>Unique identifier of the referenced AssociateRole. Required if <code>key</code> is absent.</p></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>id</dd>
Expand All @@ -234,7 +234,7 @@ <h3>getId</h3>
<h3>getKey</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html" title="class or interface in javax.annotation" class="external-link">@Nullable</a>
</span><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">getKey</span>()</div>
<div class="block"><p>Unique key of the referenced AssociateRole. Either <code>id</code> or <code>key</code> is required.</p></div>
<div class="block"><p>Unique key of the referenced AssociateRole. Required if <code>id</code> is absent.</p></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>key</dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ <h1 title="Interface AttributeGroupResourceIdentifier" class="title">Interface A
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">AttributeGroupResourceIdentifier</span><span class="extends-implements">
extends <a href="../common/ResourceIdentifier.html" title="interface in com.commercetools.api.models.common">ResourceIdentifier</a>, <a href="../Identifiable.html" title="interface in com.commercetools.api.models">Identifiable</a>&lt;<a href="AttributeGroup.html" title="interface in com.commercetools.api.models.attribute_group">AttributeGroup</a>&gt;</span></div>
<div class="block"><p>ResourceIdentifier to an AttributeGroup.</p>
<div class="block"><p>ResourceIdentifier to an AttributeGroup. Either <code>id</code> or <code>key</code> is required. If both are set, an InvalidJsonInput error is returned.</p>

<hr>
Example to create an instance using the builder pattern
Expand Down Expand Up @@ -218,7 +218,7 @@ <h2>Method Details</h2>
<section class="detail" id="getId()">
<h3>getId</h3>
<div class="member-signature"><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">getId</span>()</div>
<div class="block"><p>Platform-generated unique identifier of the referenced AttributeGroup. Either <code>id</code> or <code>key</code> is required.</p></div>
<div class="block"><p>Platform-generated unique identifier of the referenced AttributeGroup. Required if <code>key</code> is absent.</p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../Identifiable.html#getId()">getId</a></code>&nbsp;in interface&nbsp;<code><a href="../Identifiable.html" title="interface in com.commercetools.api.models">Identifiable</a>&lt;<a href="AttributeGroup.html" title="interface in com.commercetools.api.models.attribute_group">AttributeGroup</a>&gt;</code></dd>
Expand All @@ -233,7 +233,7 @@ <h3>getId</h3>
<section class="detail" id="getKey()">
<h3>getKey</h3>
<div class="member-signature"><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">getKey</span>()</div>
<div class="block"><p>User-generated unique identifier of the referenced AttributeGroup. Either <code>id</code> or <code>key</code> is required.</p></div>
<div class="block"><p>User-generated unique identifier of the referenced AttributeGroup. Required if <code>id</code> is absent.</p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../common/ResourceIdentifier.html#getKey()">getKey</a></code>&nbsp;in interface&nbsp;<code><a href="../common/ResourceIdentifier.html" title="interface in com.commercetools.api.models.common">ResourceIdentifier</a></code></dd>
Expand All @@ -248,7 +248,7 @@ <h3>getKey</h3>
<section class="detail" id="setId(java.lang.String)">
<h3>setId</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setId</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;id)</span></div>
<div class="block"><p>Platform-generated unique identifier of the referenced AttributeGroup. Either <code>id</code> or <code>key</code> is required.</p></div>
<div class="block"><p>Platform-generated unique identifier of the referenced AttributeGroup. Required if <code>key</code> is absent.</p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../common/ResourceIdentifier.html#setId(java.lang.String)">setId</a></code>&nbsp;in interface&nbsp;<code><a href="../common/ResourceIdentifier.html" title="interface in com.commercetools.api.models.common">ResourceIdentifier</a></code></dd>
Expand All @@ -261,7 +261,7 @@ <h3>setId</h3>
<section class="detail" id="setKey(java.lang.String)">
<h3>setKey</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setKey</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;key)</span></div>
<div class="block"><p>User-generated unique identifier of the referenced AttributeGroup. Either <code>id</code> or <code>key</code> is required.</p></div>
<div class="block"><p>User-generated unique identifier of the referenced AttributeGroup. Required if <code>id</code> is absent.</p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../common/ResourceIdentifier.html#setKey(java.lang.String)">setKey</a></code>&nbsp;in interface&nbsp;<code><a href="../common/ResourceIdentifier.html" title="interface in com.commercetools.api.models.common">ResourceIdentifier</a></code></dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ <h2>Method Details</h2>
<h3>id</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AttributeGroupResourceIdentifierBuilder.html" title="class in com.commercetools.api.models.attribute_group">AttributeGroupResourceIdentifierBuilder</a></span>&nbsp;<span class="element-name">id</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html" title="class or interface in javax.annotation" class="external-link">@Nullable</a>
<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;id)</span></div>
<div class="block"><p>Platform-generated unique identifier of the referenced AttributeGroup. Either <code>id</code> or <code>key</code> is required.</p></div>
<div class="block"><p>Platform-generated unique identifier of the referenced AttributeGroup. Required if <code>key</code> is absent.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>id</code> - value to be set</dd>
Expand All @@ -208,7 +208,7 @@ <h3>id</h3>
<h3>key</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AttributeGroupResourceIdentifierBuilder.html" title="class in com.commercetools.api.models.attribute_group">AttributeGroupResourceIdentifierBuilder</a></span>&nbsp;<span class="element-name">key</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html" title="class or interface in javax.annotation" class="external-link">@Nullable</a>
<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;key)</span></div>
<div class="block"><p>User-generated unique identifier of the referenced AttributeGroup. Either <code>id</code> or <code>key</code> is required.</p></div>
<div class="block"><p>User-generated unique identifier of the referenced AttributeGroup. Required if <code>id</code> is absent.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - value to be set</dd>
Expand All @@ -222,7 +222,7 @@ <h3>key</h3>
<h3>getId</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html" title="class or interface in javax.annotation" class="external-link">@Nullable</a>
</span><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">getId</span>()</div>
<div class="block"><p>Platform-generated unique identifier of the referenced AttributeGroup. Either <code>id</code> or <code>key</code> is required.</p></div>
<div class="block"><p>Platform-generated unique identifier of the referenced AttributeGroup. Required if <code>key</code> is absent.</p></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>id</dd>
Expand All @@ -234,7 +234,7 @@ <h3>getId</h3>
<h3>getKey</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/javax/annotation/Nullable.html" title="class or interface in javax.annotation" class="external-link">@Nullable</a>
</span><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">getKey</span>()</div>
<div class="block"><p>User-generated unique identifier of the referenced AttributeGroup. Either <code>id</code> or <code>key</code> is required.</p></div>
<div class="block"><p>User-generated unique identifier of the referenced AttributeGroup. Required if <code>id</code> is absent.</p></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>key</dd>
Expand Down
Loading

0 comments on commit 2df9682

Please sign in to comment.