Package org.apache.juneau.rest.client

Interface BodyConverter<T>

Type Parameters:

T - The type this converter handles.

public interface BodyConverter<T>

Converts a Java object passed to RestRequest.body(Object) into a TransportBody.

A list of converters is consulted in order; the first converter whose canConvert(Object) returns true wins. The default converter list (applied automatically by RestClient) handles the common cases:

1. HttpBody — passed through directly (streaming preferred over buffering)
2. InputStream — wrapped in a streaming body
3. byte[] — wrapped in a byte-array body
4. File — wrapped in a file body

Custom converters are registered on the builder and are prepended to the default list (checked before the defaults). Use the of(Class, ThrowingConverter) factory for concise lambdas:

Example:

RestClient client = RestClient.builder() .bodyConverter(BodyConverter.of(MyBean.class, bean -> TransportBody.of(StringBody.of(mySerializer.write(bean))))) .build();

See Also:

• Next-Generation REST Client

Since:

9.2.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BodyConverter.ThrowingConverter<T>	A checked function used by of(Class, ThrowingConverter).

Method Summary

Modifier and Type	Method	Description
boolean	canConvert(Object value)	Returns true if this converter can handle the given value.
TransportBody	convert(Object value)	Converts the value to a TransportBody.
static <T> BodyConverter<T>	of(Class<T> type, BodyConverter.ThrowingConverter<T> converter)	Creates a BodyConverter from a type predicate and a converting lambda.

Method Details

canConvert

boolean canConvert(Object value)

Returns true if this converter can handle the given value.

Parameters:

value - The value passed to RestRequest.body(Object). May be null.

Returns:

true if convert(Object) should be called with this value.

convert

TransportBody convert(Object value)
               throws IOException

Converts the value to a TransportBody.

Parameters:

value - The value. Never null (converters are only called when canConvert(java.lang.Object) returns true).

Returns:

The transport body. Never null.

Throws:

IOException - If conversion fails.

of

static <T> BodyConverter<T> of(Class<T> type,
 BodyConverter.ThrowingConverter<T> converter)

Creates a BodyConverter from a type predicate and a converting lambda.

The converter matches any value that is an instance of the given type.

Type Parameters:

T - The type to handle.

Parameters:

type - The type to match via instanceof. Must not be null.

converter - The conversion function. Must not be null.

Returns:

A new converter. Never null.