net.lecousin.framework.network.mime.entity

Class FormUrlEncodedEntity

java.lang.Object

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

net.lecousin.framework.network.mime.entity.FormUrlEncodedEntity

All Implemented Interfaces:

MimeHeadersContainer<MimeEntity>

public class FormUrlEncodedEntity
extends MimeEntity

Form parameters using x-www-form-urlencoded format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FormUrlEncodedEntity.Parser Parser for body.

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

MimeEntity.Transfer

Field Summary

Fields

Modifier and Type	Field and Description
protected List<net.lecousin.framework.util.Pair<String,String>>	parameters

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

headers, parent

Constructor Summary

Constructors

Constructor and Description
FormUrlEncodedEntity() Constructor.
FormUrlEncodedEntity(MimeEntity parent, MimeHeaders headers) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(String name, String value) Add a parameter.
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.
String	getParameter(String name) Return the parameter or null if not present.
List<net.lecousin.framework.util.Pair<String,String>>	getParameters() Return the parameters.
boolean	hasParameter(String name) Return true if the parameter is present.

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

parameters

protected List<net.lecousin.framework.util.Pair<String,String>> parameters

Constructor Detail

FormUrlEncodedEntity

public FormUrlEncodedEntity()

Constructor.

FormUrlEncodedEntity

public FormUrlEncodedEntity(MimeEntity parent,
                            MimeHeaders headers)

Constructor.

Method Detail

add

public void add(String name,
                String value)

Add a parameter.

getParameters

public List<net.lecousin.framework.util.Pair<String,String>> getParameters()

Return the parameters.

hasParameter

public boolean hasParameter(String name)

Return true if the parameter is present.

getParameter

public String getParameter(String name)

Return the parameter or null if not present.

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