Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

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.
*/
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.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ public Set<String> 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 &amp; values of custom fields as a map.
*/
@JsonAnyGetter
@Nonnull
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
* <p>
* Use the constants declared in each entity inner class. Instantiating directly requires knowing the underlying OData
* field names, so use the constructor with caution.
*
Expand Down Expand Up @@ -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.
*
* <p>
* 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.
*
Expand Down Expand Up @@ -126,7 +126,7 @@ public ExpressionFluentHelper<EntityT> ne( @Nullable final FieldT value )
* @param value
* Field value to compare with.
*
* @return Fluent helper that represents a <i>field > value</i> expression.
* @return Fluent helper that represents a <i>field &gt; value</i> expression.
*/
@Nonnull
public ExpressionFluentHelper<EntityT> gt( @Nullable final FieldT value )
Expand All @@ -140,7 +140,7 @@ public ExpressionFluentHelper<EntityT> gt( @Nullable final FieldT value )
* @param value
* Field value to compare with.
*
* @return Fluent helper that represents a <i>field >= value</i> expression.
* @return Fluent helper that represents a <i>field &ge; value</i> expression.
*/
@Nonnull
public ExpressionFluentHelper<EntityT> ge( @Nullable final FieldT value )
Expand All @@ -154,7 +154,7 @@ public ExpressionFluentHelper<EntityT> ge( @Nullable final FieldT value )
* @param value
* Field value to compare with.
*
* @return Fluent helper that represents a <i>field < value</i> expression.
* @return Fluent helper that represents a <i>field &lt; value</i> expression.
*/
@Nonnull
public ExpressionFluentHelper<EntityT> lt( @Nullable final FieldT value )
Expand All @@ -168,7 +168,7 @@ public ExpressionFluentHelper<EntityT> lt( @Nullable final FieldT value )
* @param value
* Field value to compare with.
*
* @return Fluent helper that represents a <i>field <= value</i> expression.
* @return Fluent helper that represents a <i>field &le; value</i> expression.
*/
@Nonnull
public ExpressionFluentHelper<EntityT> le( @Nullable final FieldT value )
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 &amp; populated. If this method is never
* called, then all fields will be fetched &amp; populated. But if this method is called at least once, then only
* the specified fields will be fetched &amp; populated. Calling this multiple times will combine the set(s) of
* fields of each call.
*
* @param fields
* Array of fields to select.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,7 @@ public abstract class VdmEntity<EntityT> extends VdmObject<EntityT>
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 )
Expand Down Expand Up @@ -122,7 +117,7 @@ protected String getDefaultServicePath()

/**
* Sets the service path and destination for the fetch commands of this entity.
*
* <p>
* Also applies to any associated entities (navigation properties) that were previously fetched.
* <p>
* <b>Note:</b> Use with caution, as this can easily break the fetch calls on this entity. See the interface of the
Expand Down Expand Up @@ -212,9 +207,7 @@ protected <T extends VdmEntity<T>> T fetchFieldAsSingle(
}

@Nonnull
private <T extends VdmEntity<T>> 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);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public Set<String> getCustomFieldNames()
/**
* Returns all custom field names and values of this object.
*
* @return All names & values of custom fields as a map.
* @return All names &amp; values of custom fields as a map.
*/
@JsonAnyGetter
@Nonnull
Expand Down