Package org.apache.juneau.marshall.httppart

Class BaseHttpPartSerializer

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.httppart.BaseHttpPartSerializer

All Implemented Interfaces:

HttpPartSerializer

Direct Known Subclasses:

SimplePartSerializer

public abstract class BaseHttpPartSerializer
extends MarshallingContextable
implements HttpPartSerializer

Base class for implementations of HttpPartSerializer

Notes:

• This class is thread safe and reusable.

See Also:

• HTTP Part Serializers and Parsers

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseHttpPartSerializer.Builder<SELF extends BaseHttpPartSerializer.Builder<SELF>>	Builder class.

Nested classes/interfaces inherited from interface org.apache.juneau.marshall.httppart.HttpPartSerializer

HttpPartSerializer.Creator, HttpPartSerializer.Void

Field Summary

Fields inherited from class org.apache.juneau.marshall.MarshallingContextable

marshallingContext

Fields inherited from class org.apache.juneau.marshall.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseHttpPartSerializer(BaseHttpPartSerializer.Builder<?> builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	write(HttpPartType partType, HttpPartSchema schema, 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.

Methods inherited from class org.apache.juneau.marshall.MarshallingContextable

getDurationFormat, getMarshallingContext, getPeriodFormat, properties

Methods inherited from class org.apache.juneau.marshall.Context

copy, createBuilder, createSession, getAnnotationProvider, getSession, init, isDebug, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.juneau.marshall.httppart.HttpPartSerializer

getPartSession

Constructor Details

BaseHttpPartSerializer

protected BaseHttpPartSerializer(BaseHttpPartSerializer.Builder<?> builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

write

public String write(HttpPartType partType,
 HttpPartSchema schema,
 Object value)
             throws SchemaValidationException,
SerializeException

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:

partType - The category of value being serialized.
Can be null (will default to HttpPartType.OTHER).

schema - Schema information about the part.
Can be null. The effect is implementation-dependent — see HttpPartSerializerSession.
Not all part serializers use the schema information.

value - The value being serialized.
Can be null (will return null).

Returns:

The serialized value.

Throws:

SerializeException - If a problem occurred while trying to parse the input.

SchemaValidationException - If the output fails schema validation.