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

Class StreamEntity

java.lang.Object

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

org.apache.juneau.http.classic.entity.StreamEntity

All Implemented Interfaces:

HttpEntity

Direct Known Subclasses:

StreamEntity.Unmodifiable

public class StreamEntity
extends BasicHttpEntity<StreamEntity>

A streamed, non-repeatable entity that obtains its content from an InputStream.

See Also:

• juneau-rest-common

Nested Class Summary

Nested Classes

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

Field Summary

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

EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
	StreamEntity()	Constructor.
protected	StreamEntity(StreamEntity copyFrom)	Copy constructor.
	StreamEntity(ContentType contentType, InputStream content)	Constructor.

Method Summary

Modifier and Type	Method	Description
byte[]	asBytes()	Converts the contents of this entity as a byte array.
String	asString()	Converts the contents of this entity as a string.
StreamEntity	copy()	Creates a builder for this class initialized with the contents of this bean.
boolean	equals(Object o)	Compares the shared base content of two entities.
InputStream	getContent()
long	getContentLength()
int	hashCode()
boolean	isRepeatable()
boolean	isStreaming()
StreamEntity	unmodifiable()	Returns an unmodifiable snapshot of this bean.
void	writeTo(OutputStream out)	Writes bytes from the InputStream this entity was constructed with to an OutputStream.

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

asSafeBytes, assertBytes, assertString, consumeContent, contentOrElse, freeze, getCharset, getContentEncoding, getContentType, getMaxLength, isCached, isChunked, 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

StreamEntity

public StreamEntity()

Constructor.

StreamEntity

public StreamEntity(ContentType contentType,
 InputStream content)

Constructor.

Parameters:

contentType - The entity content type. Can be null to omit an explicit Content-Type header.

content - The entity contents. Can be null, in which case a NullPointerException is thrown when the entity's content is read.

StreamEntity

protected StreamEntity(StreamEntity copyFrom)

Copy constructor.

Parameters:

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

Method Details

asBytes

public byte[] asBytes()
               throws IOException

Description copied from class: BasicHttpEntity

Converts the contents of this entity as a byte array.

Note that this may exhaust the content on non-repeatable, non-cached entities.

Overrides:

asBytes in class BasicHttpEntity<StreamEntity>

Returns:

The contents of this entity as a byte array.

Throws:

IOException - If a problem occurred while trying to read the content.

asString

public String asString()
                throws IOException

Description copied from class: BasicHttpEntity

Converts the contents of this entity as a string.

Note that this may exhaust the content on non-repeatable, non-cached entities.

Overrides:

asString in class BasicHttpEntity<StreamEntity>

Returns:

The contents of this entity as a string.

Throws:

IOException - If a problem occurred while trying to read the content.

copy

public StreamEntity copy()

Description copied from class: BasicHttpEntity

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<StreamEntity>

Returns:

A new builder bean.

getContent

public InputStream getContent()
                       throws IOException

Specified by:

getContent in interface HttpEntity

Overrides:

getContent in class BasicHttpEntity<StreamEntity>

Throws:

IOException

getContentLength

public long getContentLength()

Specified by:

getContentLength in interface HttpEntity

Overrides:

getContentLength in class BasicHttpEntity<StreamEntity>

isRepeatable

public boolean isRepeatable()

Specified by:

isRepeatable in interface HttpEntity

Overrides:

isRepeatable in class BasicHttpEntity<StreamEntity>

isStreaming

public boolean isStreaming()

Specified by:

isStreaming in interface HttpEntity

Overrides:

isStreaming in class BasicHttpEntity<StreamEntity>

unmodifiable

public StreamEntity 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<StreamEntity>

Returns:

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

writeTo

public void writeTo(OutputStream out)
             throws IOException

Writes bytes from the InputStream this entity was constructed with to an OutputStream. The content length determines how many bytes are written. If the length is unknown (-1), the stream will be completely consumed (to the end of the stream).

Specified by:

writeTo in interface HttpEntity

Overrides:

writeTo in class BasicHttpEntity<StreamEntity>

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<StreamEntity>

hashCode

public int hashCode()

Overrides:

hashCode in class BasicHttpEntity<StreamEntity>