net.lecousin.framework.network.mime.entity

Class TextEntity

java.lang.Object

net.lecousin.framework.network.mime.entity.MimeEntity

net.lecousin.framework.network.mime.entity.TextEntity

All Implemented Interfaces:

MimeHeadersContainer<MimeEntity>

public class TextEntity
extends MimeEntity

Text entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TextEntity.Consumer Consumer to parse the body.

Nested classes/interfaces inherited from class net.lecousin.framework.network.mime.entity.MimeEntity

MimeEntity.Parser, MimeEntity.Transfer

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHARSET_PARAMETER

Fields inherited from class net.lecousin.framework.network.mime.entity.MimeEntity

headers, parent

Constructor Summary

Constructors

Constructor and Description
TextEntity(MimeEntity parent, MimeHeaders from) From existing headers.
TextEntity(String text, Charset charset, String textMimeType) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	canProduceBodyRange() Return true if this entity is able to extract a range of the body.
net.lecousin.framework.concurrent.async.AsyncSupplier<net.lecousin.framework.util.Pair<Long,net.lecousin.framework.concurrent.util.AsyncProducer<ByteBuffer,IOException>>,IOException>	createBodyProducer() Create a producer of this entity's body.
net.lecousin.framework.util.Triple<net.lecousin.framework.math.RangeLong,Long,BinaryEntity>	createBodyRange(net.lecousin.framework.math.RangeLong range) Extract a range of this entity's body.
net.lecousin.framework.concurrent.util.AsyncConsumer<ByteBuffer,IOException>	createConsumer(Long size) Create a consumer of data to parse the body.
Charset	getCharset()
String	getText()
void	setCharset(Charset charset) Set the charset to encode the text.
void	setText(String text)

Methods inherited from class net.lecousin.framework.network.mime.entity.MimeEntity

getHeaders, getParent, parse, writeEntity

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.lecousin.framework.network.mime.header.MimeHeadersContainer

addHeader, addHeader, addHeader, setHeader, setHeader, setHeader

Field Detail

CHARSET_PARAMETER

public static final String CHARSET_PARAMETER

See Also:

Constant Field Values

Constructor Detail

TextEntity

public TextEntity(String text,
                  Charset charset,
                  String textMimeType)

Constructor.

TextEntity

public TextEntity(MimeEntity parent,
                  MimeHeaders from)
           throws MimeException

From existing headers.

Throws:

MimeException

Method Detail

getText

public String getText()

setText

public void setText(String text)

getCharset

public Charset getCharset()

setCharset

public void setCharset(Charset charset)
                throws MimeException

Set the charset to encode the text.

Throws:

MimeException

createBodyProducer

public net.lecousin.framework.concurrent.async.AsyncSupplier<net.lecousin.framework.util.Pair<Long,net.lecousin.framework.concurrent.util.AsyncProducer<ByteBuffer,IOException>>,IOException> createBodyProducer()

Description copied from class: MimeEntity

Create a producer of this entity's body.

Specified by:

createBodyProducer in class MimeEntity

Returns:

a Pair with the body size (or null if undetermined) and the producer

canProduceBodyRange

public boolean canProduceBodyRange()

Description copied from class: MimeEntity

Return true if this entity is able to extract a range of the body.

Specified by:

canProduceBodyRange in class MimeEntity

createBodyRange

public net.lecousin.framework.util.Triple<net.lecousin.framework.math.RangeLong,Long,BinaryEntity> createBodyRange(net.lecousin.framework.math.RangeLong range)

Description copied from class: MimeEntity

Extract a range of this entity's body. If range.min is -1, it means the last range.max bytes have to be extracted. If range.max is -1, it means to extract from range.min until the end. Else the extraction starts at range.min until range.max included. If range.max is greater than the total size, extraction is done until the end. Return values are: the range extracted (without -1 and with a max not greater than the total size), the total size, and a BinaryEntity containing the extracted body.

Specified by:

createBodyRange in class MimeEntity

createConsumer

public net.lecousin.framework.concurrent.util.AsyncConsumer<ByteBuffer,IOException> createConsumer(Long size)

Description copied from class: MimeEntity

Create a consumer of data to parse the body.

Specified by:

createConsumer in class MimeEntity

Parameters:

size - size of data to consume if known, null if unknown