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

Class ODataRequestResultGeneric

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestResultGeneric

All Implemented Interfaces:

ODataRequestResult, ODataRequestResultDeserializable, Iterable<ResultElement>

@Beta
public class ODataRequestResultGeneric
extends Object
implements ODataRequestResult, ODataRequestResultDeserializable, Iterable<ResultElement>

OData request result for reading entities.

Constructor Summary

Constructors

Constructor and Description
ODataRequestResultGeneric(ODataRequestGeneric oDataRequest, org.apache.http.HttpResponse httpResponse)

Method Summary

Modifier and Type	Method and Description
<T> T	as(Class<T> objectType) Converts ODataRequestResult into POJO
<T> List<T>	asList(Class<T> objectType) Converts ODataRequestResult into list of POJO
List<Map<String,Object>>	asListOfMaps() Construct and get a list of key-value maps from the OData response.
Map<String,Object>	asMap() Construct and get a key-value map from the OData response.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Iterable<String>	getHeaderNames() Get the iterable list of HTTP response header names.
Iterable<String>	getHeaderValues(String headerName) Get the iterable HTTP header values for a specific header name.
org.apache.http.HttpResponse	getHttpResponse() Get the original OData HttpResponse instance, which holds the HttpEntity and header information.
long	getInlineCount() Get the count of elements in the result set.
ODataRequestGeneric	getODataRequest() Get the original ODataRequestExecutable instance that was used for running the OData request.
protected Map<String,Iterable<String>>	getResponseHeaders() Get the original map of HTTP response header key-values.
io.vavr.control.Option<String>	getVersionIdentifierFromHeader() Try to extract a version identifier from the ETag header.
int	hashCode()
Iterator<ResultElement>	iterator() Create an iterator for the result elements
protected void	requireHealthyResponse() Check the HTTP response code of the OData request result.
void	streamElements(Consumer<ResultElement> handler) Run a consumer for fluent API type ResultElement to iterate over the OData response with a continuous data stream.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ODataRequestResultGeneric

public ODataRequestResultGeneric(@Nonnull
                                 ODataRequestGeneric oDataRequest,
                                 @Nonnull
                                 org.apache.http.HttpResponse httpResponse)

Method Detail

getResponseHeaders

@Nonnull
protected Map<String,Iterable<String>> getResponseHeaders()

Get the original map of HTTP response header key-values.

Returns:

The response headers.

streamElements

public void streamElements(@Nonnull
                           Consumer<ResultElement> handler)

Run a consumer for fluent API type ResultElement to iterate over the OData response with a continuous data stream. The HttpEntity will be consumed.

Specified by:

streamElements in interface ODataRequestResultDeserializable

Parameters:

handler - The consumer for generic ResultElement.

iterator

@Nonnull
public Iterator<ResultElement> iterator()

Create an iterator for the result elements

Specified by:

iterator in interface Iterable<ResultElement>

Returns:

The iterable result elements.

Throws:

ODataErrorResponseException - When the received OData service response contained a parsable error message.

ODataDeserializationException - When deserialization process failed for the OData response object.

ODataDeserializationException - When the received OData service response contained a non-parsable error message.

as

@Nonnull
public <T> T as(@Nonnull
                         Class<T> objectType)

Converts ODataRequestResult into POJO

Specified by:

as in interface ODataRequestResultDeserializable

Type Parameters:

T - The generic type of POJO

Parameters:

objectType - type of POJO

Returns:

- POJO

Throws:

ODataErrorResponseException - When the received OData service response contained a parsable error message.

ODataDeserializationException - When deserialization process failed for the OData response object.

ODataDeserializationException - When the received OData service response contained a non-parsable error message.

asList

@Nonnull
public <T> List<T> asList(@Nonnull
                                   Class<T> objectType)

Converts ODataRequestResult into list of POJO

Specified by:

asList in interface ODataRequestResultDeserializable

Type Parameters:

T - Generic type of the POJO

Parameters:

objectType - type of POJO

Returns:

List - list of POJOs

Throws:

ODataErrorResponseException - When the received OData service response contained a parsable error message.

ODataDeserializationException - When deserialization process failed for the OData response object.

ODataDeserializationException - When the received OData service response contained a non-parsable error message.

getInlineCount

public long getInlineCount()

Description copied from interface: ODataRequestResultDeserializable

Get the count of elements in the result set.

Specified by:

getInlineCount in interface ODataRequestResultDeserializable

Returns:

The number of elements.

asMap

@Nonnull
public Map<String,Object> asMap()

Description copied from interface: ODataRequestResultDeserializable

Construct and get a key-value map from the OData response. The HttpEntity will be consumed.

Specified by:

asMap in interface ODataRequestResultDeserializable

Returns:

The key-value map.

asListOfMaps

@Nonnull
public List<Map<String,Object>> asListOfMaps()

Description copied from interface: ODataRequestResultDeserializable

Construct and get a list of key-value maps from the OData response. The HttpEntity will be consumed.

Specified by:

asListOfMaps in interface ODataRequestResultDeserializable

Returns:

The list of key-value maps.

getHeaderValues

@Nonnull
public Iterable<String> getHeaderValues(@Nonnull
                                                 String headerName)

Description copied from interface: ODataRequestResult

Get the iterable HTTP header values for a specific header name.

Specified by:

getHeaderValues in interface ODataRequestResult

Parameters:

headerName - The header name to look for.

Returns:

An iterable set of header values.

getHeaderNames

@Nonnull
public Iterable<String> getHeaderNames()

Description copied from interface: ODataRequestResult

Get the iterable list of HTTP response header names.

Specified by:

getHeaderNames in interface ODataRequestResult

Returns:

An iterable set of header names.

requireHealthyResponse

protected void requireHealthyResponse()

Check the HTTP response code of the OData request result. If the code indicates an unhealthy response, an exception will be thrown with further details.

Throws:

ODataServiceException - When the response code infers an unhealthy state, i.e. when >= 400

ODataErrorResponseException - When the response contains an OData error message according to specification.

getVersionIdentifierFromHeader

@Nonnull
public io.vavr.control.Option<String> getVersionIdentifierFromHeader()

Try to extract a version identifier from the ETag header.

Returns:

An option holding the version identifier or Option.None, if none was found.

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(@Nullable
                           Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getODataRequest

@Nonnull
public ODataRequestGeneric getODataRequest()

Description copied from interface: ODataRequestResult

Get the original ODataRequestExecutable instance that was used for running the OData request.

Specified by:

getODataRequest in interface ODataRequestResult

Returns:

The original ODataRequestExecutable instance.

getHttpResponse

@Nonnull
public org.apache.http.HttpResponse getHttpResponse()

Description copied from interface: ODataRequestResult

Get the original OData HttpResponse instance, which holds the HttpEntity and header information.

Specified by:

getHttpResponse in interface ODataRequestResult

Returns:

The HttpResponse.