org.dmfs.httpclientinterfaces.headers

Interface HeaderList

All Superinterfaces:

java.lang.Iterable<Header<?>>

All Known Implementing Classes:

AbstractComplexHeaderList, ArrayHeaderList, EmptyHeaderList, JoinedHeaderList, RemoveHeaderList, SingleHeaderList

public interface HeaderList
extends java.lang.Iterable<Header<?>>

Interface of an immutable instance that holds a list of Headers.

Author:

Marten Gajda

Method Summary

Modifier and Type	Method and Description
HeaderList	append(Header<?>... newHeaders) Returns a new HeaderList that also contains the given Headers.
HeaderList	append(HeaderList newHeaders) Returns a new HeaderList that also contains the Headers in the given HeaderList.
boolean	contains(Header<?> header) Returns whether this HeaderSet contains the given Header.
boolean	contains(HeaderType<?> headerType) Returns whether this HeaderSet contains a Header of the given HeaderType.
<T> java.util.Iterator<Header<T>>	headersByType(HeaderType<T> headerType) Get an Iterator of all Headers of the given HeaderType in this list.
HeaderList	remove(HeaderType<?>... removedHeaderTypes) Returns a new HeaderList that doesn't contain any headers of the given types.
int	size() Returns the number of Headers in this HeaderList.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

append

HeaderList append(Header<?>... newHeaders)

Returns a new HeaderList that also contains the given Headers.

Parameters:

newHeaders - The Headers to add.

Returns:

A HeaderList that contains the new Headers in addition to the Headers of this list.

append

HeaderList append(HeaderList newHeaders)

Returns a new HeaderList that also contains the Headers in the given HeaderList.

Parameters:

newHeaders - The HeaderList containing the headers to add.

Returns:

A HeaderList that contains the new Headers in addition to the Headers of this list.

remove

HeaderList remove(HeaderType<?>... removedHeaderTypes)

Returns a new HeaderList that doesn't contain any headers of the given types.

Parameters:

removedHeaderTypes -

Returns:

contains

boolean contains(HeaderType<?> headerType)

Returns whether this HeaderSet contains a Header of the given HeaderType.

Parameters:

headerType -

Returns:

contains

boolean contains(Header<?> header)

Returns whether this HeaderSet contains the given Header. This is only true if the set contains a Header having the same HeaderType and value.

Parameters:

header -

Returns:

headersByType

<T> java.util.Iterator<Header<T>> headersByType(HeaderType<T> headerType)

Get an Iterator of all Headers of the given HeaderType in this list.

Parameters:

headerType - The HeaderType to look for.

Returns:

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

size

int size()

Returns the number of Headers in this HeaderList.

Returns: