org.dmfs.httpessentials.headers

Interface HeaderType<ValueType>

Type Parameters:

ValueType - The type of the header value.

All Superinterfaces:

EntityType<ValueType>

All Known Subinterfaces:

ListHeaderType<ValueType>, SingletonHeaderType<ValueType>

public interface HeaderType<ValueType>
extends EntityType<ValueType>

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

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

Method Summary

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

Methods inherited from interface org.dmfs.httpessentials.typedentity.EntityType

valueFromString

Method Detail

name

java.lang.String name()

Returns the name of the header.

Specified by:

name in interface EntityType<ValueType>

Returns:

The header name, never null.

entityFromString

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

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

Specified by:

entityFromString in interface EntityType<ValueType>

Parameters:

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

Returns:

A new Header instance.

entity

Header<ValueType> entity(ValueType value)

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

Specified by:

entity in interface EntityType<ValueType>

Parameters:

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

Returns:

A new Header instance.

valueString

java.lang.String valueString(ValueType headerValue)

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

Specified by:

valueString in interface EntityType<ValueType>

Parameters:

headerValue - The value to convert.

Returns:

A header value String representing the given value.