io.sphere.sdk.client

Class SphereRequestDecorator<T>

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.client.SphereRequestDecorator<T>

Type Parameters:

T - the type of the result of this request

All Implemented Interfaces:

SphereRequest<T>

Direct Known Subclasses:

CorrelationIdRequestDecorator

public abstract class SphereRequestDecorator<T>
extends Base
implements SphereRequest<T>

Public available base class to decorate the behaviour of SphereRequests.

Field Summary

Fields

Modifier and Type	Field and Description
protected SphereRequest<T>	delegate

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SphereRequestDecorator(SphereRequest<T> delegate)

Method Summary

Modifier and Type	Method and Description
boolean	canDeserialize(HttpResponse httpResponse) Checks if the response can be handled by SphereRequest.deserialize(HttpResponse).
T	deserialize(HttpResponse httpResponse) Takes an http response and maps it into a Java object of type T.
HttpRequestIntent	httpRequestIntent() Provides an http request intent, this does not include the execution of it.

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

delegate

protected final SphereRequest<T> delegate

Constructor Detail

SphereRequestDecorator

protected SphereRequestDecorator(SphereRequest<T> delegate)

Method Detail

canDeserialize

public boolean canDeserialize(HttpResponse httpResponse)

Description copied from interface: SphereRequest

Checks if the response can be handled by SphereRequest.deserialize(HttpResponse). Use case 1: A http response returns 404 and the this SphereRequest can handle this error by returning an empty optional, an empty list or throwing a domain specific exception.

Specified by:

canDeserialize in interface SphereRequest<T>

Parameters:

httpResponse - the http response which shall be transformed

Returns:

true if the http response can be consumed, false otherwise

httpRequestIntent

public HttpRequestIntent httpRequestIntent()

Description copied from interface: SphereRequest

Provides an http request intent, this does not include the execution of it.

Specified by:

httpRequestIntent in interface SphereRequest<T>

Returns:

http request intent

deserialize

public T deserialize(HttpResponse httpResponse)

Description copied from interface: SphereRequest

Takes an http response and maps it into a Java object of type T. Before calling this method, check with SphereRequest.canDeserialize(HttpResponse) if the response can be consumed.

Specified by:

deserialize in interface SphereRequest<T>

Parameters:

httpResponse - the http response of the API

Returns:

the deserialized object