org.apache.juneau.httppart

Interface HttpPartSerializer

All Known Subinterfaces:

HttpPartSerializer.Null

All Known Implementing Classes:

SimplePartSerializer, SimpleUonPartSerializer, UonPartSerializer

public interface HttpPartSerializer

Interface used to convert POJOs to simple strings in HTTP headers, query parameters, form-data parameters, and URI path variables.

The following default implementations are provided:

• UonPartSerializer - Parts encoded in UON notation.
• SimpleUonPartSerializer - Parts encoded in UON notation, but strings are treated as plain-text and arrays/collections are serialized as comma-delimited lists.
• SimplePartSerializer - Parts encoded in plain text.

This class is used in the following locations:

• FormData.serializer()
• FormDataIfNE.serializer()
• Query.serializer()
• QueryIfNE.serializer()
• Header.serializer()
• HeaderIfNE.serializer()
• Path.serializer()
• RequestBean.serializer()
• RestClientBuilder.partSerializer(Class)

Implementations must include either a public no-args constructor or a public constructor that takes in a single PropertyStore object.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HttpPartSerializer.Null Represent "no" part part serializer.

Method Summary

Modifier and Type	Method and Description
String	serialize(HttpPartType type, Object value) Converts the specified value to a string that can be used as an HTTP header value, query parameter value, form-data parameter, or URI path variable.

Method Detail

serialize

String serialize(HttpPartType type,
                 Object value)

Converts the specified value to a string that can be used as an HTTP header value, query parameter value, form-data parameter, or URI path variable.

Returned values should NOT be URL-encoded.

Parameters:

type - The category of value being serialized.

value - The value being serialized.

Returns:

The serialized value.