Package org.apache.juneau.http.classic.entity

Class SerializedEntity

java.lang.Object

org.apache.juneau.http.classic.entity.BasicHttpEntity<SerializedEntity>

org.apache.juneau.http.classic.entity.SerializedEntity

All Implemented Interfaces:

HttpEntity

Direct Known Subclasses:

SerializedEntity.Unmodifiable

public class SerializedEntity
extends BasicHttpEntity<SerializedEntity>

HttpEntity for serializing POJOs as the body of HTTP requests.

See Also:

• juneau-rest-common

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SerializedEntity.Unmodifiable	Unmodifiable point-in-time snapshot of the enclosing SerializedEntity.

Field Summary

Fields inherited from class org.apache.juneau.http.classic.entity.BasicHttpEntity

EMPTY

Constructor Summary

Constructors

Constructor	Description
SerializedEntity()	Constructor.
SerializedEntity(SerializedEntity copyFrom)	Copy constructor.
SerializedEntity(ContentType contentType, Object content, Serializer serializer, HttpPartSchema schema)	Constructor.

Method Summary

Modifier and Type	Method	Description
SerializedEntity	copy()	Creates a builder for this class initialized with the contents of this bean.
SerializedEntity	copyWith(Serializer serializer, HttpPartSchema schema)	Copies this bean and sets the serializer and schema on it.
boolean	equals(Object o)	Compares the shared base content of two entities.
InputStream	getContent()
long	getContentLength()
Header	getContentType()
int	hashCode()
boolean	isRepeatable()
SerializedEntity	setSchema(HttpPartSchema value)	Sets the schema on this entity bean.
SerializedEntity	setSerializer(Serializer value)	Sets the serializer on this entity bean.
SerializedEntity	unmodifiable()	Returns an unmodifiable snapshot of this bean.
void	writeTo(OutputStream os)

Methods inherited from class org.apache.juneau.http.classic.entity.BasicHttpEntity

asBytes, asSafeBytes, assertBytes, assertString, asString, consumeContent, contentOrElse, freeze, getCharset, getContentEncoding, getMaxLength, isCached, isChunked, isStreaming, isSupplied, isUnmodifiable, modify, self, setCached, setCharset, setChunked, setChunked, setContent, setContent, setContentEncoding, setContentEncoding, setContentLength, setContentType, setContentType, setMaxLength

Methods inherited from class java.lang.Object

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

Constructor Details

SerializedEntity

public SerializedEntity()

Constructor.

SerializedEntity

public SerializedEntity(ContentType contentType,
 Object content,
 Serializer serializer,
 HttpPartSchema schema)

Constructor.

Parameters:

contentType - The entity content type. Can be null, in which case the Content-Type header falls back to the serializer's primary media type (if a serializer is set) or is omitted.

content - The entity content. Can be null, in which case it's converted to an empty string if no serializer is set, or passed through to the serializer as-is otherwise.

serializer - The entity serializer. Can be null, in which case the content is written via its toString() value (or an empty string if the content is also null) instead of being serialized.

schema - The entity schema. Can be null (no schema is applied to the serializer).

SerializedEntity

public SerializedEntity(SerializedEntity copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean being copied. Must not be null.

Method Details

copy

public SerializedEntity copy()

Creates a builder for this class initialized with the contents of this bean.

Allows you to create a modifiable copy of this bean.

Specified by:

copy in class BasicHttpEntity<SerializedEntity>

Returns:

A new builder bean.

copyWith

public SerializedEntity copyWith(Serializer 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.

getContent

public InputStream getContent()

Specified by:

getContent in interface HttpEntity

Overrides:

getContent in class BasicHttpEntity<SerializedEntity>

getContentLength

public long getContentLength()

Specified by:

getContentLength in interface HttpEntity

Overrides:

getContentLength in class BasicHttpEntity<SerializedEntity>

getContentType

public Header getContentType()

Specified by:

getContentType in interface HttpEntity

Overrides:

getContentType in class BasicHttpEntity<SerializedEntity>

isRepeatable

public boolean isRepeatable()

Specified by:

isRepeatable in interface HttpEntity

Overrides:

isRepeatable in class BasicHttpEntity<SerializedEntity>

setSchema

public SerializedEntity setSchema(HttpPartSchema value)

Sets the schema on this entity bean.

Used to provide instructions to the serializer on how to serialize this object.

Parameters:

value - The entity schema, can be null (no schema is applied to the serializer).

Returns:

This object.

setSerializer

public SerializedEntity setSerializer(Serializer value)

Sets the serializer on this entity bean.

Parameters:

value - The entity serializer, can be null, in which case the content is written via its toString() value instead of being serialized.

Returns:

This object.

unmodifiable

public SerializedEntity unmodifiable()

Description copied from class: BasicHttpEntity

Returns an unmodifiable snapshot of this bean.

The returned instance is a point-in-time copy of the leaf's nested Unmodifiable type; any attempt to set a property on it throws an UnsupportedOperationException. This method is idempotent: if this bean is already unmodifiable it returns itself rather than taking another snapshot. The receiver is left unchanged (and still modifiable unless it was already unmodifiable).

Specified by:

unmodifiable in class BasicHttpEntity<SerializedEntity>

Returns:

An unmodifiable snapshot of this bean, or this bean if it is already unmodifiable.

writeTo

public void writeTo(OutputStream os)
             throws IOException

Specified by:

writeTo in interface HttpEntity

Overrides:

writeTo in class BasicHttpEntity<SerializedEntity>

Throws:

IOException

equals

public boolean equals(Object o)

Description copied from class: BasicHttpEntity

Compares the shared base content of two entities.

This base implementation compares only the fields declared on BasicHttpEntity and deliberately accepts any BasicHttpEntity subtype so that concrete leaves can delegate to it via super.equals(...). It does not gate on the concrete leaf type; each concrete leaf overrides equals to first apply an instanceof <ThatLeaf> gate (so two unrelated leaves with equal base content are not equal) and then calls super.equals(...) to compare the inherited content. Using instanceof <ThatLeaf> (rather than getClass() ==) is what preserves the immutability invariant that bean.equals(bean.unmodifiable()) holds, since each X.Unmodifiable snapshot is a subclass of its leaf X.

Overrides:

equals in class BasicHttpEntity<SerializedEntity>

hashCode

public int hashCode()

Overrides:

hashCode in class BasicHttpEntity<SerializedEntity>