net.lecousin.framework.network.mime.header

Class MimeHeaders

java.lang.Object

net.lecousin.framework.network.mime.header.MimeHeaders

public class MimeHeaders
extends Object

MIME headers container.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MimeHeaders.HeadersConsumer Consume bytes to parse headers.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_DISPOSITION
static String	CONTENT_ENCODING
static String	CONTENT_LENGTH
static String	CONTENT_TRANSFER_ENCODING
static String	CONTENT_TYPE
static String	TRANSFER_ENCODING

Constructor Summary

Constructors

Constructor and Description
MimeHeaders() Constructor.
MimeHeaders(List<MimeHeader> headers) Constructor.
MimeHeaders(MimeHeader... headers) Constructor.

Method Summary

Modifier and Type	Method and Description
MimeHeaders	add(MimeHeader header) Append a header.
MimeHeaders	add(String name, HeaderValueFormat value) Append a header.
MimeHeaders	addRawValue(String name, String rawValue) Append a header.
void	appendTo(net.lecousin.framework.text.IString s) Generate headers into the given string.
MimeHeaders.HeadersConsumer	createConsumer() Create a consumer for headers.
MimeHeaders.HeadersConsumer	createConsumer(int maximumLength) Create a consumer for headers.
void	generateString(net.lecousin.framework.text.ByteArrayStringIso8859Buffer s) Generate this MimeHeaders into a byte array string buffer.
net.lecousin.framework.text.ByteArrayStringIso8859Buffer	generateString(int bufferSize) Generate this MimeHeaders into a byte array string buffer.
Long	getContentLength()
ParameterizedHeaderValue	getContentType() Parse the Content-Type header and return it, or null if it is not present.
String	getContentTypeValue() Parse the Content-Type header and return its main value, or null if it is not present.
MimeHeader	getFirst(String name) Return the first header with the given name (case insensitive) or null.
Long	getFirstLongValue(String name) Return the value of the first header with the given name (case insensitive) parsed into a Long, or null.
String	getFirstRawValue(String name) Return the value of the first header with the given name (case insensitive), or null.
<T extends HeaderValueFormat> T	getFirstValue(String name, Class<T> format) Return the value of the first header with the given name (case insensitive) parsed into the requested format, or null.
List<MimeHeader>	getHeaders()
List<MimeHeader>	getList(String name) Return the list of headers with the given name (case insensitive).
<T extends HeaderValueFormat> List<T>	getValues(String name, Class<T> format) Return the list of headers values with the given name (case insensitive), parsed into the requested format.
boolean	has(String name) Return true if thie message contains at least one header with the given name (case insensitive).
MimeHeaders	remove(String name) Remove any header with the given name.
MimeHeaders	set(MimeHeader header) Remove any header with the same name, and append this new header.
MimeHeaders	set(String name, HeaderValueFormat value) Remove any header with the same name, and append this new header.
MimeHeaders	setContentLength(long size) Set the Content-Length header.
MimeHeaders	setRawValue(String name, String rawValue) Remove any header with the same name, and append this new header.

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

CONTENT_LENGTH

public static final String CONTENT_LENGTH

See Also:

Constant Field Values

CONTENT_DISPOSITION

public static final String CONTENT_DISPOSITION

See Also:

Constant Field Values

TRANSFER_ENCODING

public static final String TRANSFER_ENCODING

See Also:

Constant Field Values

CONTENT_TRANSFER_ENCODING

public static final String CONTENT_TRANSFER_ENCODING

See Also:

Constant Field Values

CONTENT_ENCODING

public static final String CONTENT_ENCODING

See Also:

Constant Field Values

Constructor Detail

MimeHeaders

public MimeHeaders()

Constructor.

MimeHeaders

public MimeHeaders(List<MimeHeader> headers)

Constructor.

MimeHeaders

public MimeHeaders(MimeHeader... headers)

Constructor.

Method Detail

getHeaders

public List<MimeHeader> getHeaders()

getList

public List<MimeHeader> getList(String name)

Return the list of headers with the given name (case insensitive).

getValues

public <T extends HeaderValueFormat> List<T> getValues(String name,
                                                       Class<T> format)
                                                throws MimeException

Return the list of headers values with the given name (case insensitive), parsed into the requested format.

Throws:

MimeException

getFirst

public MimeHeader getFirst(String name)

Return the first header with the given name (case insensitive) or null.

getFirstValue

public <T extends HeaderValueFormat> T getFirstValue(String name,
                                                     Class<T> format)
                                              throws MimeException

Return the value of the first header with the given name (case insensitive) parsed into the requested format, or null.

Throws:

MimeException

getFirstRawValue

public String getFirstRawValue(String name)

Return the value of the first header with the given name (case insensitive), or null.

getFirstLongValue

public Long getFirstLongValue(String name)

Return the value of the first header with the given name (case insensitive) parsed into a Long, or null.

has

public boolean has(String name)

Return true if thie message contains at least one header with the given name (case insensitive).

addRawValue

public MimeHeaders addRawValue(String name,
                               String rawValue)

Append a header.

add

public MimeHeaders add(String name,
                       HeaderValueFormat value)

Append a header.

add

public MimeHeaders add(MimeHeader header)

Append a header.

setRawValue

public MimeHeaders setRawValue(String name,
                               String rawValue)

Remove any header with the same name, and append this new header.

set

public MimeHeaders set(String name,
                       HeaderValueFormat value)

Remove any header with the same name, and append this new header.

set

public MimeHeaders set(MimeHeader header)

Remove any header with the same name, and append this new header.

remove

public MimeHeaders remove(String name)

Remove any header with the given name.

appendTo

public void appendTo(net.lecousin.framework.text.IString s)

Generate headers into the given string.

getContentLength

public Long getContentLength()

setContentLength

public MimeHeaders setContentLength(long size)

Set the Content-Length header.

getContentType

public ParameterizedHeaderValue getContentType()
                                        throws MimeException

Parse the Content-Type header and return it, or null if it is not present.

Throws:

MimeException

getContentTypeValue

public String getContentTypeValue()

Parse the Content-Type header and return its main value, or null if it is not present.

generateString

public net.lecousin.framework.text.ByteArrayStringIso8859Buffer generateString(int bufferSize)

Generate this MimeHeaders into a byte array string buffer.

generateString

public void generateString(net.lecousin.framework.text.ByteArrayStringIso8859Buffer s)

Generate this MimeHeaders into a byte array string buffer.

createConsumer

public MimeHeaders.HeadersConsumer createConsumer()

Create a consumer for headers.

createConsumer

public MimeHeaders.HeadersConsumer createConsumer(int maximumLength)

Create a consumer for headers.