Package com.sap.cloud.sdk.datamodel.odata.client

Class ODataProtocol.ODataProtocolV4

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.client.ODataProtocol.ODataProtocolV4

All Implemented Interfaces:

ODataLiteralSerializer, ODataProtocol, ODataResponseDescriptor

Enclosing interface:

ODataProtocol

public static final class ODataProtocol.ODataProtocolV4
extends Object
implements ODataProtocol

OData protocol v4.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sap.cloud.sdk.datamodel.odata.client.ODataProtocol

ODataProtocol.ODataProtocolV2, ODataProtocol.ODataProtocolV4

Field Summary

Fields inherited from interface com.sap.cloud.sdk.datamodel.odata.client.ODataProtocol

V2, V4

Constructor Summary

Constructors

Constructor	Description
ODataProtocolV4()

Method Summary

Modifier and Type	Method	Description
Function<OffsetDateTime,String>	getDateTimeOffsetSerializer()	Returns a function to convert a given OffsetDateTime into a String that conforms with the protocol specification.
Function<LocalDateTime,String>	getDateTimeSerializer()	Returns a function to convert a given LocalDateTime into a String that conforms with the protocol specification.
Function<Number,String>	getNumberSerializer()	Returns a function to convert a given Number into a String that conforms with the protocol specification.
JsonLookup	getPathToDeltaLink()	The JSON path(s) to the delta link of a versioned response.
JsonLookup	getPathToInlineCount()	The JSON path(s) to an inline count.
JsonLookup	getPathToNextLink()	The JSON path(s) to the next link of a multi page response.
JsonLookup	getPathToResultPrimitive()	The JSON path(s) to a result primitive.
JsonLookup	getPathToResultSet()	The JSON path(s) to a set of result elements.
JsonLookup	getPathToResultSingle()	The JSON path(s) to a result object.
String	getProtocolVersion()	The version number of this protocol.
Map.Entry<String,String>	getQueryOptionInlineCount(boolean optionEnabled)	Build the (inline) count query option for this protocol version.
Function<LocalTime,String>	getTimeOfDaySerializer()	Returns a function to convert a given LocalTime into a String that conforms with the protocol specification.
Function<UUID,String>	getUUIDSerializer()	Returns a function to convert a given UUID into a String that conforms with the protocol specification.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.client.ODataProtocol

isEqualTo

Constructor Details

ODataProtocolV4

public ODataProtocolV4()

Method Details

getQueryOptionInlineCount

@Nonnull
public Map.Entry<String,String> getQueryOptionInlineCount(boolean optionEnabled)

Description copied from interface: ODataProtocol

Build the (inline) count query option for this protocol version.

Specified by:

getQueryOptionInlineCount in interface ODataProtocol

Parameters:

optionEnabled - Determines the value of the query option.

Returns:

An entry to add to the URL query.

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

getProtocolVersion

public String getProtocolVersion()

Description copied from interface: ODataProtocol

The version number of this protocol.

Specified by:

getProtocolVersion in interface ODataProtocol

Returns:

A string representing the OData version, e.g. "4.0"

getPathToResultSet

public JsonLookup getPathToResultSet()

Description copied from interface: ODataResponseDescriptor

The JSON path(s) to a set of result elements. The last element of this array refers to the result array.

Specified by:

getPathToResultSet in interface ODataResponseDescriptor

Returns:

The path(s) to result set.

getPathToResultSingle

public JsonLookup getPathToResultSingle()

Description copied from interface: ODataResponseDescriptor

The JSON path(s) to a result object. The last element of this array refers to the result object.

Specified by:

getPathToResultSingle in interface ODataResponseDescriptor

Returns:

The path(s) to single result.

getPathToResultPrimitive

public JsonLookup getPathToResultPrimitive()

Description copied from interface: ODataResponseDescriptor

The JSON path(s) to a result primitive. The last element of this array refers to the result value.

Specified by:

getPathToResultPrimitive in interface ODataResponseDescriptor

Returns:

The path(s) to primitive result.

getPathToInlineCount

public JsonLookup getPathToInlineCount()

Description copied from interface: ODataResponseDescriptor

The JSON path(s) to an inline count. The last element of this array refers to the result value.

Specified by:

getPathToInlineCount in interface ODataResponseDescriptor

Returns:

The path(s) to inline count value.

getPathToNextLink

public JsonLookup getPathToNextLink()

Description copied from interface: ODataResponseDescriptor

The JSON path(s) to the next link of a multi page response. The last element of this array refers to the result value.

Specified by:

getPathToNextLink in interface ODataResponseDescriptor

Returns:

The path(s) to inline count value.

getPathToDeltaLink

public JsonLookup getPathToDeltaLink()

Description copied from interface: ODataResponseDescriptor

The JSON path(s) to the delta link of a versioned response. The last element of this array refers to the result value.

Specified by:

getPathToDeltaLink in interface ODataResponseDescriptor

Returns:

The path(s) to inline count value.

getNumberSerializer

public Function<Number,String> getNumberSerializer()

Description copied from interface: ODataLiteralSerializer

Returns a function to convert a given Number into a String that conforms with the protocol specification.

Specified by:

getNumberSerializer in interface ODataLiteralSerializer

Returns:

A serializer for Numbers.

getUUIDSerializer

public Function<UUID,String> getUUIDSerializer()

Description copied from interface: ODataLiteralSerializer

Returns a function to convert a given UUID into a String that conforms with the protocol specification.

Specified by:

getUUIDSerializer in interface ODataLiteralSerializer

Returns:

A serializer for UUIDs.

getDateTimeOffsetSerializer

public Function<OffsetDateTime,String> getDateTimeOffsetSerializer()

Description copied from interface: ODataLiteralSerializer

Returns a function to convert a given OffsetDateTime into a String that conforms with the protocol specification.

Specified by:

getDateTimeOffsetSerializer in interface ODataLiteralSerializer

Returns:

A serializer for OffsetDateTimes.

getTimeOfDaySerializer

public Function<LocalTime,String> getTimeOfDaySerializer()

Description copied from interface: ODataLiteralSerializer

Returns a function to convert a given LocalTime into a String that conforms with the protocol specification.

Specified by:

getTimeOfDaySerializer in interface ODataLiteralSerializer

Returns:

A serializer for LocalTimes.

getDateTimeSerializer

public Function<LocalDateTime,String> getDateTimeSerializer()

Description copied from interface: ODataLiteralSerializer

Returns a function to convert a given LocalDateTime into a String that conforms with the protocol specification.

Specified by:

getDateTimeSerializer in interface ODataLiteralSerializer

Returns:

A serializer for LocalDateTimes.