Package org.apache.juneau.http.entity

Class StringEntity

java.lang.Object

org.apache.juneau.http.entity.BasicHttpEntity

org.apache.juneau.http.entity.StringEntity

All Implemented Interfaces:

HttpEntity

public class StringEntity
extends BasicHttpEntity

A self contained, repeatable entity that obtains its content from a String.

See Also:

• juneau-rest-common

Constructor Summary

Constructors

Modifier	Constructor	Description
	StringEntity()	Constructor.
protected	StringEntity(StringEntity copyFrom)	Copy constructor.
	StringEntity(ContentType contentType, String 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.
StringEntity	copy()	Creates a builder for this class initialized with the contents of this bean.
InputStream	getContent()
long	getContentLength()
boolean	isRepeatable()
boolean	isStreaming()
StringEntity	setCached()	Specifies that the contents of this resource should be cached into an internal byte array so that it can be read multiple times.
StringEntity	setCharset(Charset value)	Specifies the charset to use when converting to and from stream-based resources.
StringEntity	setChunked()	Sets the 'chunked' flag value to true.
StringEntity	setChunked(boolean value)	Sets the 'chunked' flag value.
StringEntity	setContent(Object value)	Sets the content on this entity bean.
StringEntity	setContent(Supplier<?> value)	Sets the content on this entity bean from a supplier.
StringEntity	setContentEncoding(String value)	Sets the content encoding header on this entity bean.
StringEntity	setContentEncoding(ContentEncoding value)	Sets the content encoding header on this entity bean.
StringEntity	setContentLength(long value)	Sets the content length on this entity bean.
StringEntity	setContentType(String value)	Sets the content type on this entity bean.
StringEntity	setContentType(ContentType value)	Sets the content type on this entity bean.
StringEntity	setMaxLength(int value)	Specifies the maximum number of bytes to read or write to and from stream-based resources.
StringEntity	setUnmodifiable()	Specifies whether this bean should be unmodifiable.
void	writeTo(OutputStream out)

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

asSafeBytes, assertBytes, assertModifiable, assertString, consumeContent, contentOrElse, getCharset, getContentEncoding, getContentType, getMaxLength, isCached, isChunked, isSupplied, isUnmodifiable

Methods inherited from class java.lang.Object

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

Constructor Details

StringEntity

public StringEntity()

Constructor.

StringEntity

public StringEntity(ContentType contentType,
 String content)

Constructor.

Parameters:

contentType - The entity content type.

content - The entity contents.

StringEntity

protected StringEntity(StringEntity copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean being copied.

Method Details

copy

public StringEntity 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.

Overrides:

copy in class BasicHttpEntity

Returns:

A new builder bean.

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

Returns:

The contents of this entity as a string.

Throws:

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

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

Returns:

The contents of this entity as a byte array.

Throws:

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

isRepeatable

public boolean isRepeatable()

Specified by:

isRepeatable in interface HttpEntity

Overrides:

isRepeatable in class BasicHttpEntity

getContentLength

public long getContentLength()

Specified by:

getContentLength in interface HttpEntity

Overrides:

getContentLength in class BasicHttpEntity

getContent

public InputStream getContent()
                       throws IOException

Specified by:

getContent in interface HttpEntity

Overrides:

getContent in class BasicHttpEntity

Throws:

IOException

writeTo

public void writeTo(OutputStream out)
             throws IOException

Specified by:

writeTo in interface HttpEntity

Overrides:

writeTo in class BasicHttpEntity

Throws:

IOException

isStreaming

public boolean isStreaming()

Specified by:

isStreaming in interface HttpEntity

Overrides:

isStreaming in class BasicHttpEntity

setCached

public StringEntity setCached()
                       throws IOException

Description copied from class: BasicHttpEntity

Specifies that the contents of this resource should be cached into an internal byte array so that it can be read multiple times.

Overrides:

setCached in class BasicHttpEntity

Returns:

This object.

Throws:

IOException - If entity could not be read into memory.

setCharset

public StringEntity setCharset(Charset value)

Description copied from class: BasicHttpEntity

Specifies the charset to use when converting to and from stream-based resources.

Overrides:

setCharset in class BasicHttpEntity

Parameters:

value - The new value. If null, UTF-8 is assumed.

Returns:

This object.

setChunked

public StringEntity setChunked()

Description copied from class: BasicHttpEntity

Sets the 'chunked' flag value to true.

Notes:

• If the HttpEntity.getContentLength() method returns a negative value, the HttpClient code will always use chunked encoding.

Overrides:

setChunked in class BasicHttpEntity

Returns:

This object.

setChunked

public StringEntity setChunked(boolean value)

Description copied from class: BasicHttpEntity

Sets the 'chunked' flag value.

Notes:

• If the HttpEntity.getContentLength() method returns a negative value, the HttpClient code will always use chunked encoding.

Overrides:

setChunked in class BasicHttpEntity

Parameters:

value - The new value for this flag.

Returns:

This object.

setContent

public StringEntity setContent(Object value)

Description copied from class: BasicHttpEntity

Sets the content on this entity bean.

Overrides:

setContent in class BasicHttpEntity

Parameters:

value - The entity content, can be null.

Returns:

This object.

setContent

public StringEntity setContent(Supplier<?> value)

Description copied from class: BasicHttpEntity

Sets the content on this entity bean from a supplier.

Repeatable entities such as StringEntity use this to allow the entity content to be resolved at serialization time.

Overrides:

setContent in class BasicHttpEntity

Parameters:

value - The entity content, can be null.

Returns:

This object.

setContentEncoding

public StringEntity setContentEncoding(String value)

Description copied from class: BasicHttpEntity

Sets the content encoding header on this entity bean.

Overrides:

setContentEncoding in class BasicHttpEntity

Parameters:

value - The new Content-Encoding header, or null to unset.

Returns:

This object.

setContentEncoding

public StringEntity setContentEncoding(ContentEncoding value)

Description copied from class: BasicHttpEntity

Sets the content encoding header on this entity bean.

Overrides:

setContentEncoding in class BasicHttpEntity

Parameters:

value - The new Content-Encoding header, or null to unset.

Returns:

This object.

setContentLength

public StringEntity setContentLength(long value)

Description copied from class: BasicHttpEntity

Sets the content length on this entity bean.

Overrides:

setContentLength in class BasicHttpEntity

Parameters:

value - The new Content-Length header value, or -1 to unset.

Returns:

This object.

setContentType

public StringEntity setContentType(String value)

Description copied from class: BasicHttpEntity

Sets the content type on this entity bean.

Overrides:

setContentType in class BasicHttpEntity

Parameters:

value - The new Content-Type header, or null to unset.

Returns:

This object.

setContentType

public StringEntity setContentType(ContentType value)

Description copied from class: BasicHttpEntity

Sets the content type on this entity bean.

Overrides:

setContentType in class BasicHttpEntity

Parameters:

value - The new Content-Type header, or null to unset.

Returns:

This object.

setMaxLength

public StringEntity setMaxLength(int value)

Description copied from class: BasicHttpEntity

Specifies the maximum number of bytes to read or write to and from stream-based resources.

Implementation is not universal.

Overrides:

setMaxLength in class BasicHttpEntity

Parameters:

value - The new value. The default is -1 which means read everything.

Returns:

This object.

setUnmodifiable

public StringEntity setUnmodifiable()

Description copied from class: BasicHttpEntity

Specifies whether this bean should be unmodifiable.

When enabled, attempting to set any properties on this bean will cause an UnsupportedOperationException.

Overrides:

setUnmodifiable in class BasicHttpEntity

Returns:

This object.