org.dmfs.httpclientinterfaces.headers

Interface HeaderType<ValueType>

Type Parameters:

ValueType - The type of the header value.

All Known Implementing Classes:

SimpleHeaderType

public interface HeaderType<ValueType>

Represents a header type. That is, it binds a header name to a value type.

Two HeaderTypes are considered to equal if they have the same header name.

Author:

Marten Gajda

Method Summary

Modifier and Type	Method and Description
Header<ValueType>	header(ValueType value) Factory method to create Headers of this type from a value.
Header<ValueType>	headerFromString(java.lang.String headerValueString) Factory method to create Headers of this type from the given String representation.
java.lang.String	headerName() Returns the name of the header.
java.lang.String	valueToString(ValueType headerValue) Returns the string representation of the given value as defined for this HeaderType.

Method Detail

headerName

java.lang.String headerName()

Returns the name of the header.

Returns:

The header name, never null.

headerFromString

Header<ValueType> headerFromString(java.lang.String headerValueString)

Factory method to create Headers of this type from the given String representation.

Parameters:

headerValueString - The String representation of the Header as transferred over the wire.

Returns:

A new Header instance.

header

Header<ValueType> header(ValueType value)

Factory method to create Headers of this type from a value.

Parameters:

header - The value of the header, must not be null

Returns:

A new Header instance.

valueToString

java.lang.String valueToString(ValueType headerValue)

Returns the string representation of the given value as defined for this HeaderType.

Parameters:

headerValue - The value to convert.

Returns:

A header value String representing the given value.