io.netty.handler.codec.http

Class DefaultHttpHeaders

java.lang.Object

io.netty.handler.codec.http.HttpHeaders

io.netty.handler.codec.http.DefaultHttpHeaders

All Implemented Interfaces:

Iterable<Map.Entry<String,String>>

public class DefaultHttpHeaders
extends HttpHeaders

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.handler.codec.http.HttpHeaders

HttpHeaders.Names, HttpHeaders.Values

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	validate

Fields inherited from class io.netty.handler.codec.http.HttpHeaders

EMPTY_HEADERS

Constructor Summary

Constructors

Constructor and Description
DefaultHttpHeaders()
DefaultHttpHeaders(boolean validate)

Method Summary

Methods

Modifier and Type	Method and Description
HttpHeaders	add(CharSequence name, Iterable<?> values) Adds a new header with the specified name and values.
HttpHeaders	add(CharSequence name, Object value) Adds a new header with the specified name and value.
HttpHeaders	add(HttpHeaders headers) Adds all header entries of the specified headers.
HttpHeaders	clear() Removes all headers from this HttpMessage.
boolean	contains(CharSequence name) Checks to see if there is a header with the specified name
boolean	contains(CharSequence name, CharSequence value, boolean ignoreCaseValue) Returns true if a header with the name and value exists.
List<Map.Entry<String,String>>	entries() Returns a new List that contains all headers in this object.
String	get(CharSequence name) Returns the value of a header with the specified name.
List<String>	getAll(CharSequence name) Returns the values of headers with the specified name
boolean	isEmpty() Checks if no header exists.
Iterator<Map.Entry<String,String>>	iterator()
Set<String>	names() Returns a new Set that contains the names of all headers in this object.
HttpHeaders	remove(CharSequence name) Removes the header with the specified name.
HttpHeaders	set(CharSequence name, Iterable<?> values) Sets a header with the specified name and values.
HttpHeaders	set(CharSequence name, Object value) Sets a header with the specified name and value.
HttpHeaders	set(HttpHeaders headers) Cleans the current header entries and copies all header entries of the specified headers.

Methods inherited from class io.netty.handler.codec.http.HttpHeaders

addDateHeader, addHeader, addIntHeader, clearHeaders, encodeAscii, equalsIgnoreCase, getContentLength, getContentLength, getDate, getDate, getDateHeader, getDateHeader, getHeader, getHeader, getHost, getHost, getIntHeader, getIntHeader, is100ContinueExpected, isContentLengthSet, isKeepAlive, isTransferEncodingChunked, newEntity, removeHeader, removeTransferEncodingChunked, set100ContinueExpected, set100ContinueExpected, setContentLength, setDate, setDateHeader, setDateHeader, setHeader, setHeader, setHost, setIntHeader, setIntHeader, setKeepAlive, setTransferEncodingChunked

Methods inherited from class java.lang.Object

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

Field Detail

validate

protected final boolean validate

Constructor Detail

DefaultHttpHeaders

public DefaultHttpHeaders()

DefaultHttpHeaders

public DefaultHttpHeaders(boolean validate)

Method Detail

add

public HttpHeaders add(HttpHeaders headers)

Description copied from class: HttpHeaders

Adds all header entries of the specified headers.

Overrides:

add in class HttpHeaders

Returns:

this

set

public HttpHeaders set(HttpHeaders headers)

Description copied from class: HttpHeaders

Cleans the current header entries and copies all header entries of the specified headers.

Overrides:

set in class HttpHeaders

Returns:

this

add

public HttpHeaders add(CharSequence name,
              Object value)

Description copied from class: HttpHeaders

Adds a new header with the specified name and value. If the specified value is not a String, it is converted into a String by Object.toString(), except in the cases of Date and Calendar, which are formatted to the date format defined in RFC2616.

Specified by:

add in class HttpHeaders

Parameters:

name - The name of the header being added

value - The value of the header being added

Returns:

this

add

public HttpHeaders add(CharSequence name,
              Iterable<?> values)

Description copied from class: HttpHeaders

Adds a new header with the specified name and values. This getMethod can be represented approximately as the following code:

 for (Object v: values) {
     if (v == null) {
         break;
     }
     headers.add(name, v);
 }
 

Specified by:

add in class HttpHeaders

Parameters:

name - The name of the headers being set

values - The values of the headers being set

Returns:

this

remove

public HttpHeaders remove(CharSequence name)

Description copied from class: HttpHeaders

Removes the header with the specified name.

Specified by:

remove in class HttpHeaders

Parameters:

name - The name of the header to remove

Returns:

this

set

public HttpHeaders set(CharSequence name,
              Object value)

Description copied from class: HttpHeaders

Sets a header with the specified name and value. If there is an existing header with the same name, it is removed. If the specified value is not a String, it is converted into a String by Object.toString(), except for Date and Calendar, which are formatted to the date format defined in RFC2616.

Specified by:

set in class HttpHeaders

Parameters:

name - The name of the header being set

value - The value of the header being set

Returns:

this

set

public HttpHeaders set(CharSequence name,
              Iterable<?> values)

Description copied from class: HttpHeaders

Sets a header with the specified name and values. If there is an existing header with the same name, it is removed. This getMethod can be represented approximately as the following code:

 headers.remove(name);
 for (Object v: values) {
     if (v == null) {
         break;
     }
     headers.add(name, v);
 }
 

Specified by:

set in class HttpHeaders

Parameters:

name - The name of the headers being set

values - The values of the headers being set

Returns:

this

clear

public HttpHeaders clear()

Description copied from class: HttpHeaders

Removes all headers from this HttpMessage.

Specified by:

clear in class HttpHeaders

Returns:

this

get

public String get(CharSequence name)

Description copied from class: HttpHeaders

Returns the value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.

Specified by:

get in class HttpHeaders

Parameters:

name - The name of the header to search

Returns:

The first header value or null if there is no such header

getAll

public List<String> getAll(CharSequence name)

Description copied from class: HttpHeaders

Returns the values of headers with the specified name

Specified by:

getAll in class HttpHeaders

Parameters:

name - The name of the headers to search

Returns:

A List of header values which will be empty if no values are found

entries

public List<Map.Entry<String,String>> entries()

Description copied from class: HttpHeaders

Returns a new List that contains all headers in this object. Note that modifying the returned List will not affect the state of this object. If you intend to enumerate over the header entries only, use Iterable.iterator() instead, which has much less overhead.

Specified by:

entries in class HttpHeaders

iterator

public Iterator<Map.Entry<String,String>> iterator()

contains

public boolean contains(CharSequence name)

Description copied from class: HttpHeaders

Checks to see if there is a header with the specified name

Specified by:

contains in class HttpHeaders

Parameters:

name - The name of the header to search for

Returns:

True if at least one header is found

isEmpty

public boolean isEmpty()

Description copied from class: HttpHeaders

Checks if no header exists.

Specified by:

isEmpty in class HttpHeaders

contains

public boolean contains(CharSequence name,
               CharSequence value,
               boolean ignoreCaseValue)

Description copied from class: HttpHeaders

Returns true if a header with the name and value exists.

Overrides:

contains in class HttpHeaders

Parameters:

name - the headername

value - the value

ignoreCaseValue - true if case should be ignored

Returns:

contains true if it contains it false otherwise

names

public Set<String> names()

Description copied from class: HttpHeaders

Returns a new Set that contains the names of all headers in this object. Note that modifying the returned Set will not affect the state of this object. If you intend to enumerate over the header entries only, use Iterable.iterator() instead, which has much less overhead.

Specified by:

names in class HttpHeaders