bayou.text

Class TextHttpEntity

java.lang.Object

bayou.text.TextHttpEntity

All Implemented Interfaces:

HttpEntity

public class TextHttpEntity
extends Object
implements HttpEntity

An HttpEntity representing some texts.

The entity body is a sequence of bytes encoding the texts, using the charset specified in the content type.

This entity is usually for "text/*" content types, but may also be used for other types like "application/javascript".

This is a sharable entity. If this entity is to be served to multiple http messages, consider the CachedHttpEntity wrapper.

Constructor Summary

Constructors

Constructor and Description
TextHttpEntity(TextDoc doc) Create a TextHttpEntity over the TextDoc.
TextHttpEntity(ContentType contentType, Stream<? extends CharSequence> texts) Create a TextHttpEntity of the texts.
TextHttpEntity(ContentType contentType, CharSequence... texts) Create a TextHttpEntity of the texts.
TextHttpEntity(CharSequence... texts) Create a TextHttpEntity of the texts, as "text/plain;charset=UTF-8".

Method Summary

Instance Methods
ByteSource	body() The entity body.
ContentType	contentType() The content type.
Long	contentLength() The length of the entity body.
Instant	lastModified() When this entity was last modified.

Methods inherited from class java.lang.Object

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

Methods inherited from interface bayou.http.HttpEntity

bodyBytes, bodyString, contentEncoding, etag, etagIsWeak, expires

Constructor Detail

TextHttpEntity

public TextHttpEntity(TextDoc doc)

Create a TextHttpEntity over the TextDoc.

TextHttpEntity

public TextHttpEntity(ContentType contentType,
                      Stream<? extends CharSequence> texts)

Create a TextHttpEntity of the texts.

The content type should have a "charset" parameter, otherwise UTF-8 is used for encoding.

TextHttpEntity

public TextHttpEntity(ContentType contentType,
                      CharSequence... texts)

Create a TextHttpEntity of the texts.

The content type should have a "charset" parameter, otherwise UTF-8 is used for encoding.

TextHttpEntity

public TextHttpEntity(CharSequence... texts)

Create a TextHttpEntity of the texts, as "text/plain;charset=UTF-8".

Method Detail

body

public ByteSource body()

The entity body.

The entity body is a sequence of bytes encoding the texts, using the charset specified in the content type.

Specified by:

body in interface HttpEntity

contentType

public ContentType contentType()

The content type.

Specified by:

contentType in interface HttpEntity

contentLength

public Long contentLength()

The length of the entity body.

This implementation may return null, because it's difficult to know the length without actually performing the encoding.

Specified by:

contentLength in interface HttpEntity

lastModified

public Instant lastModified()

When this entity was last modified.

This implementation returns the time this object was instantiated.

Specified by:

lastModified in interface HttpEntity