net.lenni0451.commons.httpclient

Class HeaderStore<T extends HeaderStore<T>>

java.lang.Object

net.lenni0451.commons.httpclient.HeaderStore<T>

Direct Known Subclasses:

HttpClient, HttpRequest, HttpResponse

public abstract class HeaderStore<T extends HeaderStore<T>>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
HeaderStore()
HeaderStore(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

Method Summary

Modifier and Type	Method and Description
T	appendHeader(java.util.Collection<HttpHeader> headers) Append a header.
T	appendHeader(HttpHeader... headers) Append a header.
T	appendHeader(java.lang.String name, java.lang.String value) Append a header.
T	clearHeaders() Clear all headers.
java.util.Optional<java.lang.String>	getFirstHeader(java.lang.String name) Get the first header with the given name.
java.util.List<java.lang.String>	getHeader(java.lang.String name) Get a header.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getHeaders()
java.util.Optional<java.lang.String>	getLastHeader(java.lang.String name) Get the last header with the given name.
boolean	hasHeader(HttpHeader header) Check if a header is set.
boolean	hasHeader(java.lang.String name) Check if a header is set.
boolean	hasHeader(java.lang.String name, java.lang.String value) Check if a header is set.
T	removeHeader(java.lang.String name) Remove a header.
T	setHeader(java.util.Collection<HttpHeader> headers) Set a header.
T	setHeader(HttpHeader... headers) Set a header.
T	setHeader(java.lang.String name, java.lang.String value) Set a header.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeaderStore

public HeaderStore()

HeaderStore

public HeaderStore(@Nonnull
                   java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

Method Detail

getHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaders()

Returns:

The headers

getHeader

public java.util.List<java.lang.String> getHeader(@Nonnull
                                                  java.lang.String name)

Get a header.

Parameters:

name - The name of the header

Returns:

The header or null if not set

getFirstHeader

public java.util.Optional<java.lang.String> getFirstHeader(@Nonnull
                                                           java.lang.String name)

Get the first header with the given name.

Parameters:

name - The name of the header

Returns:

The response header

getLastHeader

public java.util.Optional<java.lang.String> getLastHeader(@Nonnull
                                                          java.lang.String name)

Get the last header with the given name.

Parameters:

name - The name of the header

Returns:

The response header

appendHeader

public T appendHeader(@Nonnull
                      java.lang.String name,
                      @Nonnull
                      java.lang.String value)

Append a header. If the header already exists it will be appended to the list.

Parameters:

name - The name of the header

value - The value of the header

Returns:

This instance for chaining

appendHeader

public T appendHeader(@Nonnull
                      HttpHeader... headers)

Append a header. If the header already exists it will be appended to the list.

Parameters:

headers - The headers to add

Returns:

This instance for chaining

appendHeader

public T appendHeader(@Nonnull
                      java.util.Collection<HttpHeader> headers)

Append a header. If the header already exists it will be appended to the list.

Parameters:

headers - The headers to add

Returns:

This instance for chaining

setHeader

public T setHeader(@Nonnull
                   java.lang.String name,
                   @Nonnull
                   java.lang.String value)

Set a header. If the header already exists it will be overwritten.

Parameters:

name - The name of the header

value - The value of the header

Returns:

This instance for chaining

setHeader

public T setHeader(@Nonnull
                   HttpHeader... headers)

Set a header. If the header already exists it will be overwritten.

Parameters:

headers - The headers to set

Returns:

This instance for chaining

setHeader

public T setHeader(@Nonnull
                   java.util.Collection<HttpHeader> headers)

Set a header. If the header already exists it will be overwritten.

Parameters:

headers - The headers to set

Returns:

This instance for chaining

removeHeader

public T removeHeader(@Nonnull
                      java.lang.String name)

Remove a header.

Parameters:

name - The name of the header

Returns:

This instance for chaining

clearHeaders

public T clearHeaders()

Clear all headers.

Returns:

This instance for chaining

hasHeader

public boolean hasHeader(@Nonnull
                         java.lang.String name)

Check if a header is set.

Parameters:

name - The name of the header

Returns:

Whether the header is set

hasHeader

public boolean hasHeader(@Nonnull
                         java.lang.String name,
                         @Nonnull
                         java.lang.String value)

Check if a header is set.

Parameters:

name - The name of the header

value - The value of the header

Returns:

Whether the header is set

hasHeader

public boolean hasHeader(@Nonnull
                         HttpHeader header)

Check if a header is set.

Parameters:

header - The header to check

Returns:

Whether the header is set