Package org.apache.juneau.httppart

Interface HttpPartSerializer

All Known Subinterfaces:

HttpPartSerializer.Void

All Known Implementing Classes:

BaseHttpPartSerializer, OpenApiSerializer, SimplePartSerializer, UonSerializer, UonSerializer.Encoding, UonSerializer.Readable, UrlEncodingSerializer, UrlEncodingSerializer.Expanded, UrlEncodingSerializer.PlainText, UrlEncodingSerializer.Readable

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:

• OpenApiSerializer - Parts encoded based on OpenAPI schema.
• UonSerializer - Parts encoded in UON notation.
• SimplePartSerializer - Parts encoded in plain text.

This class is used in the following locations:

• FormData.serializer()
• Query.serializer()
• Header.serializer()
• Path.serializer()
• Request.serializer()
• Response.serializer()
• RestClient.Builder.partSerializer(Class)

Implementations must include either a public no-args constructor.

See Also:

• HTTP Part Serializers and Parsers

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HttpPartSerializer.Creator	A creator for a part serializer.
static interface	HttpPartSerializer.Void	Represent "no" part part serializer.

Method Summary

Modifier and Type	Method	Description
static HttpPartSerializer.Creator	creator()	Instantiates a creator for a part serializer.
HttpPartSerializerSession	getPartSession()	Creates a new serializer session.

Method Details

creator

static HttpPartSerializer.Creator creator()

Instantiates a creator for a part serializer.

Returns:

A new creator.

getPartSession

HttpPartSerializerSession getPartSession()

Creates a new serializer session.

Returns:

A new serializer session.