org.attribyte.api.http

Class Header

java.lang.Object

org.attribyte.api.http.Header

public final class Header
extends java.lang.Object

An immutable HTTP request or response header.

Author:

Matt Hamer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTENT_TYPE The content type header.
java.lang.String	name The header name.
static java.util.Comparator<Header>	nameComparator Compare headers by name.
<any>	values An immutable list of header values.

Constructor Summary

Constructors

Constructor and Description
Header(java.lang.String name, java.util.Collection<java.lang.String> values) Creates a multi-valued header from a collection of values.
Header(java.lang.String name, java.lang.String value) Creates a single-valued header.
Header(java.lang.String name, java.lang.String[] values) Creates a multi-valued header from an array of values.

Method Summary

Modifier and Type	Method and Description
Header	addValue(java.lang.String value) Returns a copy of this header with the new value added.
static java.lang.String	getCharset(java.lang.String contentType, java.lang.String defaultCharset) Gets the charset from a content type header.
java.lang.String	getName() Gets the name.
java.lang.String	getValue() Gets the first value.
<any>	getValueList() Gets an immutable list of values.
java.lang.String[]	getValues() Gets all the values.
static java.util.List<Parameter>	parseParameters(java.lang.String headerValue) Parses ';' separated parameters in a header value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

The content type header.

See Also:

Constant Field Values

nameComparator

public static final java.util.Comparator<Header> nameComparator

Compare headers by name. Safe for use by many threads.

name

public final java.lang.String name

The header name.

values

public final <any> values

An immutable list of header values.

Constructor Detail

Header

public Header(java.lang.String name,
              java.lang.String value)

Creates a single-valued header.

Parameters:

name - The header name.

value - The header value.

Header

public Header(java.lang.String name,
              java.lang.String[] values)

Creates a multi-valued header from an array of values.

Parameters:

name - The header name.

values - The header values.

Header

public Header(java.lang.String name,
              java.util.Collection<java.lang.String> values)

Creates a multi-valued header from a collection of values.

Parameters:

name - The header name.

values - The header values.

Method Detail

addValue

public Header addValue(java.lang.String value)

Returns a copy of this header with the new value added.

Parameters:

value - The added value.

Returns:

The new header.

getName

public java.lang.String getName()

Gets the name.

Returns:

The name.

getValue

public java.lang.String getValue()

Gets the first value.

Never returns null. If the header has no value(s), an empty string is returned.

getValues

public java.lang.String[] getValues()

Gets all the values.

Returns:

The values.

getValueList

public <any> getValueList()

Gets an immutable list of values.

Returns:

The values.

parseParameters

public static java.util.List<Parameter> parseParameters(java.lang.String headerValue)

Parses ';' separated parameters in a header value.

Parameters:

headerValue - The header value.

Returns:

A list of parameters.

getCharset

public static java.lang.String getCharset(java.lang.String contentType,
                                          java.lang.String defaultCharset)

Gets the charset from a content type header.

Parameters:

contentType - The content type header value.

defaultCharset - The default charset to return if none is specified.

Returns:

The charset.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object