Package org.apache.juneau.http.classic.part

Class SerializedPart

java.lang.Object

org.apache.juneau.http.classic.part.BasicPart

org.apache.juneau.http.classic.part.SerializedPart

All Implemented Interfaces:

NameValuePair, Headerable

public class SerializedPart
extends BasicPart

Subclass of NameValuePair for serializing POJOs as URL-encoded form post entries using the class.

Example:

NameValuePairs params = new NameValuePairs() .append(new SerializedNameValuePair("myPojo", pojo, UrlEncodingSerializer.DEFAULT_SIMPLE)) .append(new BasicNameValuePair("someOtherParam", "foobar")); request.setEntity(new UrlEncodedFormEntity(params));

See Also:

• juneau-rest-common

Constructor Summary

Constructors

Modifier	Constructor	Description
	SerializedPart(String name, Object value, HttpPartType type, HttpPartSerializerSession serializer, HttpPartSchema schema, boolean skipIfEmpty)	Constructor.
protected	SerializedPart(SerializedPart copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
SerializedHeader	asHeader()	Convert the object to a Header.
SerializedPart	copy()	Creates a copy of this object.
SerializedPart	copyWith(HttpPartSerializerSession serializer, HttpPartSchema schema)	Copies this bean and sets the serializer and schema on it.
String	getValue()
static SerializedPart	of(String name, Object value)	Instantiates a new instance of this object.
static SerializedPart	of(String name, Supplier<?> value)	Instantiates a new instance of this object.
SerializedPart	schema(HttpPartSchema value)	Sets the schema object that defines the format of the output.
SerializedPart	serializer(HttpPartSerializer value)	Sets the serializer to use for serializing the value to a string value.
SerializedPart	serializer(HttpPartSerializerSession value)	Sets the serializer to use for serializing the value to a string value.
SerializedPart	skipIfEmpty()	Don't serialize this pair if the value is null or an empty string.
SerializedPart	skipIfEmpty(boolean value)	Don't serialize this pair if the value is null or an empty string.
SerializedPart	type(HttpPartType value)	Sets the HTTP part type.

Methods inherited from class org.apache.juneau.http.classic.part.BasicPart

assertName, assertValue, canCast, cast, equals, getName, getRawValue, hashCode, ofPair, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SerializedPart

public SerializedPart(String name,
 Object value,
 HttpPartType type,
 HttpPartSerializerSession serializer,
 HttpPartSchema schema,
 boolean skipIfEmpty)

Constructor.

Parameters:

name - The part name.

value - The POJO to serialize to The part value.

type - The HTTP part type. Can be null. The effect is implementation-dependent — see HttpPartSerializerSession.write(org.apache.juneau.commons.httppart.HttpPartType, org.apache.juneau.marshall.httppart.HttpPartSchema, java.lang.Object).

serializer - The serializer to use for serializing the value to a string value.
Can be null, in which case the value is converted using a simple string conversion instead of being serialized.

schema - The schema object that defines the format of the output.
If null, defaults to the schema defined on the serializer.
If that's also null, defaults to HttpPartSchema.DEFAULT.
Only used if serializer is schema-aware (e.g. OpenApiSerializer).

skipIfEmpty - If value is a blank string, the value should return as null.

SerializedPart

protected SerializedPart(SerializedPart copyFrom)

Copy constructor.

Parameters:

copyFrom - The object to copy. Must not be null.

Method Details

of

public static SerializedPart of(String name,
 Object value)

Instantiates a new instance of this object.

Parameters:

name - The part name.

value - The part value.
Can be any POJO.

Returns:

A new SerializedPart object, never null.

of

public static SerializedPart of(String name,
 Supplier<?> value)

Instantiates a new instance of this object.

Parameters:

name - The part name.

value - The part value supplier.
Can be a supplier of any POJO.

Returns:

A new SerializedPart object, never null.

asHeader

public SerializedHeader asHeader()

Description copied from interface: Headerable

Convert the object to a Header.

Specified by:

asHeader in interface Headerable

Overrides:

asHeader in class BasicPart

Returns:

The object converted to a Header.

copy

public SerializedPart copy()

Creates a copy of this object.

Returns:

A new copy of this object.

copyWith

public SerializedPart copyWith(HttpPartSerializerSession serializer,
 HttpPartSchema schema)

Copies this bean and sets the serializer and schema on it.

Parameters:

serializer - The new serializer for the bean. Can be null (the serializer is left unchanged).

schema - The new schema for the bean. Can be null (the schema is left unchanged).

Returns:

Either a new bean with the serializer set, or this bean if both values are null or the serializer and schema were already set.

getValue

public String getValue()

Specified by:

getValue in interface NameValuePair

Overrides:

getValue in class BasicPart

schema

public SerializedPart schema(HttpPartSchema value)

Sets the schema object that defines the format of the output.

Parameters:

value - The new value for this property. Can be null to fall back to HttpPartSchema.DEFAULT when the value is read.

Returns:

This object.

serializer

public SerializedPart serializer(HttpPartSerializer value)

Sets the serializer to use for serializing the value to a string value.

Parameters:

value - The new value for this property. Can be null (no-op).

Returns:

This object.

serializer

public SerializedPart serializer(HttpPartSerializerSession value)

Sets the serializer to use for serializing the value to a string value.

Parameters:

value - The new value for this property. Can be null, in which case the value is converted using a simple string conversion instead of being serialized.

Returns:

This object.

skipIfEmpty

public SerializedPart skipIfEmpty()

Don't serialize this pair if the value is null or an empty string.

Returns:

This object.

skipIfEmpty

public SerializedPart skipIfEmpty(boolean value)

Don't serialize this pair if the value is null or an empty string.

Parameters:

value - The new value of this setting.

Returns:

This object.

type

public SerializedPart type(HttpPartType value)

Sets the HTTP part type.

Parameters:

value - The new value for this property. Can be null. The effect is implementation-dependent — see HttpPartSerializerSession.write(org.apache.juneau.commons.httppart.HttpPartType, org.apache.juneau.marshall.httppart.HttpPartSchema, java.lang.Object).

Returns:

This object.