Package org.dmfs.httpessentials.headers

Interface Headers

All Superinterfaces:

Iterable<Header<?>>

public interface Headers
extends Iterable<Header<?>>

Interface of an object that holds a list of Headers. Instances must be immutable.

Method Summary

Modifier and Type	Method	Description
boolean	contains(HeaderType<?> headerType)	Returns whether these Headers contain a Header of the given HeaderType.
<T> Header<List<T>>	header(ListHeaderType<T> headerType)	Returns the value of the header of the given ListHeaderType.
<T> Header<T>	header(SingletonHeaderType<T> headerType)	Returns the value of the header of the given SingletonHeaderType.
<T> Headers	withHeader(Header<T> header)	Returns Headers that contain the given header.
<T> Headers	withoutHeaderType(HeaderType<T> headerType)	Removes any header of the given HeaderType and returns the resulting Headers.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Details

contains

boolean contains(HeaderType<?> headerType)

Returns whether these Headers contain a Header of the given HeaderType.

Parameters:

headerType -

Returns:

header

<T> Header<T> header(SingletonHeaderType<T> headerType)

Returns the value of the header of the given SingletonHeaderType.

Parameters:

headerType - The HeaderType to look for.

Returns:

An Iterator of Headers, may be empty, but never null.

Throws:

NoSuchElementException - if no such header exists within these Headers.

header

<T> Header<List<T>> header(ListHeaderType<T> headerType)

Returns the value of the header of the given ListHeaderType.

Parameters:

headerType - The HeaderType to look for.

Returns:

An Iterator of Headers, may be empty, but never null.

Throws:

NoSuchElementException - if no such header exists within these Headers.

withHeader

<T> Headers withHeader(Header<T> header)

Returns Headers that contain the given header. If another header of the same type already exists in this object, it is overridden with the new header.

Parameters:

header - The header to add.

Returns:

Headers that contain the given header.

withoutHeaderType

<T> Headers withoutHeaderType(HeaderType<T> headerType)

Removes any header of the given HeaderType and returns the resulting Headers.

Parameters:

headerType - The HeaderType of the headers to remove.

Returns:

Headers that don't contain any header of the given type.