io.sphere.sdk.queries

Class MetaModelHeadDslImpl<R,T,C extends MetaModelHeadDsl<R,T,C>>

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.queries.MetaModelHeadDslImpl<R,T,C>

Type Parameters:

R - result type, maybe directly T or sth. like List<T>

T - type of the query result

C - type of the class implementing this class

All Implemented Interfaces:

SphereRequest<R>, Head<R>, HeadDsl<R,T,C>, MetaModelHeadDsl<R,T,C>

public abstract class MetaModelHeadDslImpl<R,T,C extends MetaModelHeadDsl<R,T,C>>
extends Base
implements MetaModelHeadDsl<R,T,C>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetaModelHeadDslImpl(com.fasterxml.jackson.databind.JavaType javaType, String endpoint, String identifierToSearchFor, Function<MetaModelHeadDslBuilder<R,T,C>,C> builderFunction, List<NameValuePair> additionalParameters)
protected	MetaModelHeadDslImpl(JsonEndpoint<R> endpoint, String identifierToSearchFor, Function<MetaModelHeadDslBuilder<R,T,C>,C> builderFunction, List<NameValuePair> additionalParameters)
protected	MetaModelHeadDslImpl(MetaModelHeadDslBuilder<R,T,C> builder)
protected	MetaModelHeadDslImpl(String identifierToSearchFor, JsonEndpoint<R> endpoint, Function<MetaModelHeadDslBuilder<R,T,C>,C> builderFunction)

Method Summary

Modifier and Type	Method and Description
protected List<NameValuePair>	additionalQueryParameters()
boolean	canDeserialize(HttpResponse httpResponse) Checks if the response can be handled by SphereRequest.deserialize(HttpResponse).
protected MetaModelHeadDslBuilder<R,T,C>	copyBuilder()
R	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.
protected com.fasterxml.jackson.databind.JavaType	jacksonJavaType()
protected C	withAdditionalQueryParameters(List<NameValuePair> pairs)

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

Constructor Detail

MetaModelHeadDslImpl

protected MetaModelHeadDslImpl(JsonEndpoint<R> endpoint,
                               String identifierToSearchFor,
                               Function<MetaModelHeadDslBuilder<R,T,C>,C> builderFunction,
                               List<NameValuePair> additionalParameters)

MetaModelHeadDslImpl

protected MetaModelHeadDslImpl(String identifierToSearchFor,
                               JsonEndpoint<R> endpoint,
                               Function<MetaModelHeadDslBuilder<R,T,C>,C> builderFunction)

MetaModelHeadDslImpl

protected MetaModelHeadDslImpl(MetaModelHeadDslBuilder<R,T,C> builder)

MetaModelHeadDslImpl

protected MetaModelHeadDslImpl(com.fasterxml.jackson.databind.JavaType javaType,
                               String endpoint,
                               @Nullable
                               String identifierToSearchFor,
                               Function<MetaModelHeadDslBuilder<R,T,C>,C> builderFunction,
                               List<NameValuePair> additionalParameters)

Method Detail

deserialize

@Nullable
public R 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<R>

Specified by:

deserialize in interface Head<R>

Parameters:

httpResponse - the http response of the API

Returns:

the deserialized object

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<R>

Returns:

http request intent

jacksonJavaType

protected com.fasterxml.jackson.databind.JavaType jacksonJavaType()

additionalQueryParameters

protected List<NameValuePair> additionalQueryParameters()

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<R>

Parameters:

httpResponse - the http response which shall be transformed

Returns:

true if the http response can be consumed, false otherwise

copyBuilder

protected MetaModelHeadDslBuilder<R,T,C> copyBuilder()

withAdditionalQueryParameters

protected C withAdditionalQueryParameters(List<NameValuePair> pairs)