diff --git a/cloudplatform/cloudplatform-connectivity/src/main/java/com/sap/cloud/sdk/cloudplatform/connectivity/DestinationOptions.java b/cloudplatform/cloudplatform-connectivity/src/main/java/com/sap/cloud/sdk/cloudplatform/connectivity/DestinationOptions.java index 22e4ad613..295380226 100644 --- a/cloudplatform/cloudplatform-connectivity/src/main/java/com/sap/cloud/sdk/cloudplatform/connectivity/DestinationOptions.java +++ b/cloudplatform/cloudplatform-connectivity/src/main/java/com/sap/cloud/sdk/cloudplatform/connectivity/DestinationOptions.java @@ -138,10 +138,10 @@ public Builder augmentBuilder( @Nonnull final DestinationOptionsAugmenter augmen } /** - * Creates an immutable instance of {@link DestinationOptions) with whatever parameters have been set through + * Creates an immutable instance of {@link DestinationOptions} with whatever parameters have been set through * the builder and any augmenters attached to it. * - * @return An immutable instance of {@link DestinationOptions). + * @return An immutable instance of {@link DestinationOptions}. */ @Nonnull public DestinationOptions build() diff --git a/cloudplatform/tenant/src/main/java/com/sap/cloud/sdk/cloudplatform/tenant/TenantWithSubdomain.java b/cloudplatform/tenant/src/main/java/com/sap/cloud/sdk/cloudplatform/tenant/TenantWithSubdomain.java index 2ca0fbce1..230fa93fc 100644 --- a/cloudplatform/tenant/src/main/java/com/sap/cloud/sdk/cloudplatform/tenant/TenantWithSubdomain.java +++ b/cloudplatform/tenant/src/main/java/com/sap/cloud/sdk/cloudplatform/tenant/TenantWithSubdomain.java @@ -3,7 +3,7 @@ import javax.annotation.Nullable; /** - * Represents a {@link Tenant) that can be accessed through a subdomain. + * Represents a {@link Tenant} that can be accessed through a subdomain. */ public interface TenantWithSubdomain extends Tenant { diff --git a/datamodel/odata-client/src/main/java/com/sap/cloud/sdk/datamodel/odata/client/expression/FilterExpressionCollection.java b/datamodel/odata-client/src/main/java/com/sap/cloud/sdk/datamodel/odata/client/expression/FilterExpressionCollection.java index 465306014..35a0e15fe 100644 --- a/datamodel/odata-client/src/main/java/com/sap/cloud/sdk/datamodel/odata/client/expression/FilterExpressionCollection.java +++ b/datamodel/odata-client/src/main/java/com/sap/cloud/sdk/datamodel/odata/client/expression/FilterExpressionCollection.java @@ -156,10 +156,11 @@ static ValueNumeric.Expression length( @Nonnull final Expressions.OperandMultipl } /** - * Returns a {@link ValueCollection.Expression} that extracts the subsequence of {@code operand1) starting from - * {@code operand2) ({@code "substring"}). + * Returns a {@link ValueCollection.Expression} that extracts the subsequence of {@code operand1} starting from + * {@code operand2} ({@code "substring"}). * - * @param operand1 The collection to get the subsequence from. + * @param operand1 + * The collection to get the subsequence from. * * @param operand2 * The index of the first element of the subsequence to be extracted. @@ -175,11 +176,11 @@ static ValueNumeric.Expression length( @Nonnull final Expressions.OperandMultipl } /** - * Returns a {@link ValueCollection.Expression} that extracts the subsequence of {@code operand1) starting from - * {@code operand2) with length {@code operand3} ({@code "substring"}). - * - * @param operand1 The collection to get the subsequence from. + * Returns a {@link ValueCollection.Expression} that extracts the subsequence of {@code operand1} starting from + * {@code operand2} with length {@code operand3} ({@code "substring"}). * + * @param operand1 + * The collection to get the subsequence from. * @param operand2 * The index of the first element of the subsequence to be extracted. * @param operand3 diff --git a/datamodel/odata-client/src/main/java/com/sap/cloud/sdk/datamodel/odata/client/query/QuerySerializable.java b/datamodel/odata-client/src/main/java/com/sap/cloud/sdk/datamodel/odata/client/query/QuerySerializable.java index b4687db95..c2db448c0 100644 --- a/datamodel/odata-client/src/main/java/com/sap/cloud/sdk/datamodel/odata/client/query/QuerySerializable.java +++ b/datamodel/odata-client/src/main/java/com/sap/cloud/sdk/datamodel/odata/client/query/QuerySerializable.java @@ -2,7 +2,7 @@ import javax.annotation.Nonnull; -import com.sap.cloud.sdk.datamodel.odata.client.request.ODataUriFactory; +import com.sap.cloud.sdk.datamodel.odata.client.request.UriEncodingStrategy; /** * A serializable query interface to serve an encoded and not-encoded String representation. @@ -10,8 +10,8 @@ public interface QuerySerializable { /** - * Compute the encoded string representation of this query. All characters except the ones listed in - * {@link ODataUriFactory#SAFE_CHARS_IN_QUERY} are encoded + * Compute the encoded string representation of this query with the following {@link UriEncodingStrategy#REGULAR} + * strategy. * * @return A string representing the encoded request query. */ diff --git a/datamodel/odata-client/src/main/java/com/sap/cloud/sdk/datamodel/odata/client/request/ODataRequestReadByKey.java b/datamodel/odata-client/src/main/java/com/sap/cloud/sdk/datamodel/odata/client/request/ODataRequestReadByKey.java index 32409df48..628b5424a 100644 --- a/datamodel/odata-client/src/main/java/com/sap/cloud/sdk/datamodel/odata/client/request/ODataRequestReadByKey.java +++ b/datamodel/odata-client/src/main/java/com/sap/cloud/sdk/datamodel/odata/client/request/ODataRequestReadByKey.java @@ -76,7 +76,8 @@ public ODataRequestReadByKey( /** * Constructor with StructuredQuery for OData read requests on entity collections directly. For operations on nested - * entity collections use {@link #ODataRequestRead(String, ODataResourcePath, String, ODataProtocol)}. + * entity collections use + * {@link ODataRequestRead#ODataRequestRead(String, ODataResourcePath, String, ODataProtocol)}. * * @param servicePath * The OData service path. diff --git a/datamodel/odata-v4/odata-v4-core/src/main/java/com/sap/cloud/sdk/datamodel/odatav4/core/VdmObject.java b/datamodel/odata-v4/odata-v4-core/src/main/java/com/sap/cloud/sdk/datamodel/odatav4/core/VdmObject.java index ff8a77c77..7dedb8f7f 100644 --- a/datamodel/odata-v4/odata-v4-core/src/main/java/com/sap/cloud/sdk/datamodel/odatav4/core/VdmObject.java +++ b/datamodel/odata-v4/odata-v4-core/src/main/java/com/sap/cloud/sdk/datamodel/odatav4/core/VdmObject.java @@ -79,7 +79,7 @@ public Set getCustomFieldNames() /** * Returns the names and values of a custom field. * - * @return All of the names & values of custom fields as a map. + * @return All the names & values of custom fields as a map. */ @JsonAnyGetter @Nonnull diff --git a/datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/EntityField.java b/datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/EntityField.java index 8fafde880..27a63b243 100644 --- a/datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/EntityField.java +++ b/datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/EntityField.java @@ -15,7 +15,7 @@ /** * Template class to represent entity fields. Instances of this object are used in query modifier methods of the entity * fluent helpers. Contains methods to compare a field's value with a provided value. - * + *

* Use the constants declared in each entity inner class. Instantiating directly requires knowing the underlying OData * field names, so use the constructor with caution. * @@ -53,7 +53,7 @@ public EntityField( @Nonnull final String fieldName ) /** * Use the constants declared in each entity inner class. Instantiating directly requires knowing the underlying * OData field names, so use with caution. - * + *

* When creating instances for custom fields, this constructor can be used to add a type converter that will be * automatically used by the respective entity when getting or setting custom fields. * @@ -126,7 +126,7 @@ public ExpressionFluentHelper ne( @Nullable final FieldT value ) * @param value * Field value to compare with. * - * @return Fluent helper that represents a field > value expression. + * @return Fluent helper that represents a field > value expression. */ @Nonnull public ExpressionFluentHelper gt( @Nullable final FieldT value ) @@ -140,7 +140,7 @@ public ExpressionFluentHelper gt( @Nullable final FieldT value ) * @param value * Field value to compare with. * - * @return Fluent helper that represents a field >= value expression. + * @return Fluent helper that represents a field ≥ value expression. */ @Nonnull public ExpressionFluentHelper ge( @Nullable final FieldT value ) @@ -154,7 +154,7 @@ public ExpressionFluentHelper ge( @Nullable final FieldT value ) * @param value * Field value to compare with. * - * @return Fluent helper that represents a field < value expression. + * @return Fluent helper that represents a field < value expression. */ @Nonnull public ExpressionFluentHelper lt( @Nullable final FieldT value ) @@ -168,7 +168,7 @@ public ExpressionFluentHelper lt( @Nullable final FieldT value ) * @param value * Field value to compare with. * - * @return Fluent helper that represents a field <= value expression. + * @return Fluent helper that represents a field ≤ value expression. */ @Nonnull public ExpressionFluentHelper le( @Nullable final FieldT value ) diff --git a/datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/FluentHelperByKey.java b/datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/FluentHelperByKey.java index 07d720312..618d155ef 100644 --- a/datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/FluentHelperByKey.java +++ b/datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/FluentHelperByKey.java @@ -78,9 +78,10 @@ public FluentHelperT withQueryParameter( @Nonnull final String key, @Nullable fi } /** - * Query modifier to limit which field values of the entity get fetched & populated. If this method is never called, - * then all fields will be fetched & populated. But if this method is called at least once, then only the specified - * fields will be fetched & populated. Calling this multiple times will combine the set(s) of fields of each call. + * Query modifier to limit which field values of the entity get fetched & populated. If this method is never + * called, then all fields will be fetched & populated. But if this method is called at least once, then only + * the specified fields will be fetched & populated. Calling this multiple times will combine the set(s) of + * fields of each call. * * @param fields * Array of fields to select. diff --git a/datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/VdmEntity.java b/datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/VdmEntity.java index 51a338041..04b6f0c72 100644 --- a/datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/VdmEntity.java +++ b/datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/VdmEntity.java @@ -53,12 +53,7 @@ public abstract class VdmEntity extends VdmObject private transient String servicePathForFetch; /** - * Convienence field for reusing the same destination with multiple queries (e.g. fetching associated entities). - * - * @param destination - * New destination to apply to this entity - * - * @return The stored destination for executing queries, or null if no such context has been set. + * Convenience field for reusing the same destination with multiple queries (e.g. fetching associated entities). */ @Getter( AccessLevel.PROTECTED ) @Setter( AccessLevel.PROTECTED ) @@ -122,7 +117,7 @@ protected String getDefaultServicePath() /** * Sets the service path and destination for the fetch commands of this entity. - * + *

* Also applies to any associated entities (navigation properties) that were previously fetched. *

* Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the @@ -212,9 +207,7 @@ protected > T fetchFieldAsSingle( } @Nonnull - private > ODataRequestResultGeneric fetchField( - final String fieldName, - final Destination destination ) + private ODataRequestResultGeneric fetchField( final String fieldName, final Destination destination ) { final ODataEntityKey entityKey = ODataEntityKey.of(getKey(), ODataProtocol.V2); final ODataResourcePath path = ODataResourcePath.of(getEntityCollection(), entityKey).addSegment(fieldName); diff --git a/datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/VdmObject.java b/datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/VdmObject.java index fb91a13eb..48549f0e4 100644 --- a/datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/VdmObject.java +++ b/datamodel/odata/odata-core/src/main/java/com/sap/cloud/sdk/datamodel/odata/helper/VdmObject.java @@ -62,7 +62,7 @@ public Set getCustomFieldNames() /** * Returns all custom field names and values of this object. * - * @return All names & values of custom fields as a map. + * @return All names & values of custom fields as a map. */ @JsonAnyGetter @Nonnull