Package com.linecorp.armeria.client

Interface ResponseAs<T,R>

All Known Subinterfaces:

FutureResponseAs<T>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@UnstableApi
@FunctionalInterface
public interface ResponseAs<T,R>

Transforms a response into another.

Method Summary

Modifier and Type	Method	Description
default <V> ResponseAs<T,V>	andThen(ResponseAs<R,V> after)	Returns a composed ResponseAs that first applies this ResponseAs to its input, and then applies the after ResponseAs to the result.
R	as(T response)	Transforms the response into another.
static ResponseAs<HttpResponse,AggregatedHttpResponse>	blocking()	Aggregates an HttpResponse and waits the result of HttpResponse.aggregate().
static FutureResponseAs<ResponseEntity<byte[]>>	bytes()	Aggregates an HttpResponse and converts the AggregatedHttpObject.content() into bytes.
static <T> FutureResponseAs<ResponseEntity<T>>	json(TypeReference<? extends T> typeRef)	Aggregates an HttpResponse and deserializes the JSON AggregatedHttpObject.content() into the specified Java type using the default ObjectMapper.
static <T> FutureResponseAs<ResponseEntity<T>>	json(TypeReference<? extends T> typeRef, ObjectMapper mapper)	Aggregates an HttpResponse and deserializes the JSON AggregatedHttpObject.content() into the specified Java type using the specified ObjectMapper.
static <T> FutureResponseAs<ResponseEntity<T>>	json(Class<? extends T> clazz)	Aggregates an HttpResponse and deserializes the JSON AggregatedHttpObject.content() into the specified non-container type using the default ObjectMapper.
static <T> FutureResponseAs<ResponseEntity<T>>	json(Class<? extends T> clazz, ObjectMapper mapper)	Aggregates an HttpResponse and deserializes the JSON AggregatedHttpObject.content() into the specified non-container type using the specified ObjectMapper.
static FutureResponseAs<ResponseEntity<Path>>	path(Path path)	Writes the content of an HttpResponse into the specified Path.
default boolean	requiresAggregation()	Returns whether the response should be aggregated.
static FutureResponseAs<ResponseEntity<String>>	string()	Aggregates an HttpResponse and converts the AggregatedHttpObject.content() into String.

Method Details

blocking

@UnstableApi
static ResponseAs<HttpResponse,AggregatedHttpResponse> blocking()

Aggregates an HttpResponse and waits the result of HttpResponse.aggregate().

bytes

@UnstableApi
static FutureResponseAs<ResponseEntity<byte[]>> bytes()

Aggregates an HttpResponse and converts the AggregatedHttpObject.content() into bytes.

string

@UnstableApi
static FutureResponseAs<ResponseEntity<String>> string()

Aggregates an HttpResponse and converts the AggregatedHttpObject.content() into String.

path

@UnstableApi
static FutureResponseAs<ResponseEntity<Path>> path(Path path)

Writes the content of an HttpResponse into the specified Path.

json

@UnstableApi
static <T> FutureResponseAs<ResponseEntity<T>> json(Class<? extends T> clazz)

Aggregates an HttpResponse and deserializes the JSON AggregatedHttpObject.content() into the specified non-container type using the default ObjectMapper.

Note that this method should NOT be used if the result type is a container (Collection or Map. Use json(TypeReference) for the container type.

See Also:

• JacksonObjectMapperProvider

json

@UnstableApi
static <T> FutureResponseAs<ResponseEntity<T>> json(Class<? extends T> clazz,
 ObjectMapper mapper)

Aggregates an HttpResponse and deserializes the JSON AggregatedHttpObject.content() into the specified non-container type using the specified ObjectMapper.

Note that this method should NOT be used if the result type is a container (Collection or Map. Use json(TypeReference, ObjectMapper) for the container type.

json

@UnstableApi
static <T> FutureResponseAs<ResponseEntity<T>> json(TypeReference<? extends T> typeRef)

Aggregates an HttpResponse and deserializes the JSON AggregatedHttpObject.content() into the specified Java type using the default ObjectMapper.

See Also:

• JacksonObjectMapperProvider

json

@UnstableApi
static <T> FutureResponseAs<ResponseEntity<T>> json(TypeReference<? extends T> typeRef,
 ObjectMapper mapper)

Aggregates an HttpResponse and deserializes the JSON AggregatedHttpObject.content() into the specified Java type using the specified ObjectMapper.

as

@UnstableApi
R as(T response)

Transforms the response into another.

requiresAggregation

@UnstableApi
default boolean requiresAggregation()

Returns whether the response should be aggregated.

andThen

@UnstableApi
default <V> ResponseAs<T,V> andThen(ResponseAs<R,V> after)

Returns a composed ResponseAs that first applies this ResponseAs to its input, and then applies the after ResponseAs to the result.