io.netty.handler.codec.http

Class DefaultHttpHeaders

java.lang.Object

io.netty.handler.codec.DefaultHeaders<UnconvertedType>

io.netty.handler.codec.DefaultConvertibleHeaders<CharSequence,String>

io.netty.handler.codec.DefaultTextHeaders

io.netty.handler.codec.http.DefaultHttpHeaders

All Implemented Interfaces:

ConvertibleHeaders<CharSequence,String>, Headers<CharSequence>, HttpHeaders, TextHeaders, Iterable<Map.Entry<CharSequence,CharSequence>>

public class DefaultHttpHeaders
extends DefaultTextHeaders
implements HttpHeaders

Nested Class Summary

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

DefaultTextHeaders.DefaultTextValueTypeConverter

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

DefaultHeaders.HashCodeGenerator<T>, DefaultHeaders.IdentityNameConverter<T>, DefaultHeaders.KeyValueHeaderIterator, DefaultHeaders.NameConverter<T>

Nested classes/interfaces inherited from interface io.netty.handler.codec.TextHeaders

TextHeaders.EntryVisitor, TextHeaders.NameVisitor

Nested classes/interfaces inherited from interface io.netty.handler.codec.ConvertibleHeaders

ConvertibleHeaders.TypeConverter<UnconvertedType,ConvertedType>

Nested classes/interfaces inherited from interface io.netty.handler.codec.Headers

Headers.ValueConverter<T>

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultHttpHeaders()
	DefaultHttpHeaders(boolean validate)
protected	DefaultHttpHeaders(boolean validate, boolean singleHeaderFields)
protected	DefaultHttpHeaders(boolean validate, DefaultHeaders.NameConverter<CharSequence> nameConverter, boolean singleHeaderFields)

Method Summary

Methods

Modifier and Type	Method and Description
HttpHeaders	add(CharSequence name, CharSequence... values) Adds a new header with the specified name and values.
HttpHeaders	add(CharSequence name, CharSequence value) Adds a new header with the specified name and value.
HttpHeaders	add(CharSequence name, Iterable<? extends CharSequence> values) Adds a new header with the specified name and values.
HttpHeaders	add(TextHeaders headers) See Headers.add(Headers)
HttpHeaders	addBoolean(CharSequence name, boolean value) Add the name to value.
HttpHeaders	addByte(CharSequence name, byte value) Add the name to value.
HttpHeaders	addChar(CharSequence name, char value) Add the name to value.
HttpHeaders	addDouble(CharSequence name, double value) Add the name to value.
HttpHeaders	addFloat(CharSequence name, float value) Add the name to value.
HttpHeaders	addInt(CharSequence name, int value) Add the name to value.
HttpHeaders	addLong(CharSequence name, long value) Add the name to value.
HttpHeaders	addObject(CharSequence name, Iterable<?> values) Adds a new header with the specified name and values.
HttpHeaders	addObject(CharSequence name, Object... values) Adds a new header with the specified name and values.
HttpHeaders	addObject(CharSequence name, Object value) Adds a new header with the specified name and value.
HttpHeaders	addShort(CharSequence name, short value) Add the name to value.
HttpHeaders	addTimeMillis(CharSequence name, long value) Add the name to value.
HttpHeaders	clear() Removes all headers.
HttpHeaders	set(CharSequence name, CharSequence... values) Sets a header with the specified name and values.
HttpHeaders	set(CharSequence name, CharSequence value) Sets a header with the specified name and value.
HttpHeaders	set(CharSequence name, Iterable<? extends CharSequence> values) Sets a header with the specified name and values.
HttpHeaders	set(TextHeaders headers) See Headers.set(Headers)
HttpHeaders	setAll(TextHeaders headers) See Headers.setAll(Headers)
HttpHeaders	setBoolean(CharSequence name, boolean value) Set the name to value.
HttpHeaders	setByte(CharSequence name, byte value) Set the name to value.
HttpHeaders	setChar(CharSequence name, char value) Set the name to value.
HttpHeaders	setDouble(CharSequence name, double value) Set the name to value.
HttpHeaders	setFloat(CharSequence name, float value) Set the name to value.
HttpHeaders	setInt(CharSequence name, int value) Set the name to value.
HttpHeaders	setLong(CharSequence name, long value) Set the name to value.
HttpHeaders	setObject(CharSequence name, Iterable<?> values) Sets a header with the specified name and values.
HttpHeaders	setObject(CharSequence name, Object... values) Sets a header with the specified name and values.
HttpHeaders	setObject(CharSequence name, Object value) Sets a header with the specified name and value.
HttpHeaders	setShort(CharSequence name, short value) Set the name to value.
HttpHeaders	setTimeMillis(CharSequence name, long value) Set the name to value.

Methods inherited from class io.netty.handler.codec.DefaultTextHeaders

contains, containsObject

Methods inherited from class io.netty.handler.codec.DefaultConvertibleHeaders

entriesConverted, getAllAndConvert, getAllAndRemoveAndConvert, getAndConvert, getAndConvert, getAndRemoveAndConvert, getAndRemoveAndConvert, iteratorConverted, namesAndConvert

Methods inherited from class io.netty.handler.codec.DefaultHeaders

add, contains, contains, contains, contains, containsBoolean, containsByte, containsChar, containsDouble, containsFloat, containsInt, containsLong, containsObject, containsObject, containsObject, containsShort, containsTimeMillis, entries, equals, forEachEntry, forEachName, get, get, getAll, getAllAndRemove, getAndRemove, getAndRemove, getBoolean, getBoolean, getBooleanAndRemove, getBooleanAndRemove, getByte, getByte, getByteAndRemove, getByteAndRemove, getChar, getChar, getCharAndRemove, getCharAndRemove, getDouble, getDouble, getDoubleAndRemove, getDoubleAndRemove, getFloat, getFloat, getFloatAndRemove, getFloatAndRemove, getInt, getInt, getInt, getIntAndRemove, getIntAndRemove, getLong, getLong, getLongAndRemove, getLongAndRemove, getShort, getShortAndRemove, getShortAndRemove, getTimeMillis, getTimeMillis, getTimeMillisAndRemove, getTimeMillisAndRemove, hashCode, isEmpty, iterator, names, namesList, remove, set, setAll, size, toString, valueConverter

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty.handler.codec.TextHeaders

contains, containsObject

Methods inherited from interface io.netty.handler.codec.ConvertibleHeaders

entriesConverted, getAllAndConvert, getAllAndRemoveAndConvert, getAndConvert, getAndConvert, getAndRemoveAndConvert, getAndRemoveAndConvert, iteratorConverted, namesAndConvert

Methods inherited from interface io.netty.handler.codec.Headers

add, contains, contains, contains, contains, containsBoolean, containsByte, containsChar, containsDouble, containsFloat, containsInt, containsLong, containsObject, containsObject, containsObject, containsShort, containsTimeMillis, entries, forEachEntry, forEachName, get, get, getAll, getAllAndRemove, getAndRemove, getAndRemove, getBoolean, getBoolean, getBooleanAndRemove, getBooleanAndRemove, getByte, getByte, getByteAndRemove, getByteAndRemove, getChar, getChar, getCharAndRemove, getCharAndRemove, getDouble, getDouble, getDoubleAndRemove, getDoubleAndRemove, getFloat, getFloat, getFloatAndRemove, getFloatAndRemove, getInt, getInt, getInt, getIntAndRemove, getIntAndRemove, getLong, getLong, getLongAndRemove, getLongAndRemove, getShort, getShortAndRemove, getShortAndRemove, getTimeMillis, getTimeMillis, getTimeMillisAndRemove, getTimeMillisAndRemove, isEmpty, iterator, names, namesList, remove, set, setAll, size

Constructor Detail

DefaultHttpHeaders

public DefaultHttpHeaders()

DefaultHttpHeaders

public DefaultHttpHeaders(boolean validate)

DefaultHttpHeaders

protected DefaultHttpHeaders(boolean validate,
                  boolean singleHeaderFields)

DefaultHttpHeaders

protected DefaultHttpHeaders(boolean validate,
                  DefaultHeaders.NameConverter<CharSequence> nameConverter,
                  boolean singleHeaderFields)

Method Detail

add

public HttpHeaders add(CharSequence name,
              CharSequence value)

Description copied from interface: Headers

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 interface Headers<CharSequence>

Specified by:

add in interface HttpHeaders

Specified by:

add in interface TextHeaders

Overrides:

add in class DefaultTextHeaders

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<? extends CharSequence> values)

Description copied from interface: Headers

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 interface Headers<CharSequence>

Specified by:

add in interface HttpHeaders

Specified by:

add in interface TextHeaders

Overrides:

add in class DefaultTextHeaders

Parameters:

name - the name of the headepublic abstract rs being set

values - the values of the headers being set

Returns:

this

add

public HttpHeaders add(CharSequence name,
              CharSequence... values)

Description copied from interface: Headers

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 interface Headers<CharSequence>

Specified by:

add in interface HttpHeaders

Specified by:

add in interface TextHeaders

Overrides:

add in class DefaultTextHeaders

Parameters:

name - the name of the headepublic abstract rs being set

values - the values of the headers being set

Returns:

this

addObject

public HttpHeaders addObject(CharSequence name,
                    Object value)

Description copied from interface: Headers

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:

addObject in interface Headers<CharSequence>

Specified by:

addObject in interface HttpHeaders

Specified by:

addObject in interface TextHeaders

Overrides:

addObject in class DefaultTextHeaders

Parameters:

name - the name of the header being added

value - the value of the header being added

Returns:

this

addObject

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

Description copied from interface: Headers

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:

addObject in interface Headers<CharSequence>

Specified by:

addObject in interface HttpHeaders

Specified by:

addObject in interface TextHeaders

Overrides:

addObject in class DefaultTextHeaders

Parameters:

name - the name of the headepublic abstract rs being set

values - the values of the headers being set

Returns:

this

addObject

public HttpHeaders addObject(CharSequence name,
                    Object... values)

Description copied from interface: Headers

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:

addObject in interface Headers<CharSequence>

Specified by:

addObject in interface HttpHeaders

Specified by:

addObject in interface TextHeaders

Overrides:

addObject in class DefaultTextHeaders

Parameters:

name - the name of the headepublic abstract rs being set

values - the values of the headers being set

Returns:

this

addBoolean

public HttpHeaders addBoolean(CharSequence name,
                     boolean value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addBoolean in interface Headers<CharSequence>

Specified by:

addBoolean in interface HttpHeaders

Specified by:

addBoolean in interface TextHeaders

Overrides:

addBoolean in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

addChar

public HttpHeaders addChar(CharSequence name,
                  char value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addChar in interface Headers<CharSequence>

Specified by:

addChar in interface HttpHeaders

Specified by:

addChar in interface TextHeaders

Overrides:

addChar in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

addByte

public HttpHeaders addByte(CharSequence name,
                  byte value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addByte in interface Headers<CharSequence>

Specified by:

addByte in interface HttpHeaders

Specified by:

addByte in interface TextHeaders

Overrides:

addByte in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

addShort

public HttpHeaders addShort(CharSequence name,
                   short value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addShort in interface Headers<CharSequence>

Specified by:

addShort in interface HttpHeaders

Specified by:

addShort in interface TextHeaders

Overrides:

addShort in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

addInt

public HttpHeaders addInt(CharSequence name,
                 int value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addInt in interface Headers<CharSequence>

Specified by:

addInt in interface HttpHeaders

Specified by:

addInt in interface TextHeaders

Overrides:

addInt in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

addLong

public HttpHeaders addLong(CharSequence name,
                  long value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addLong in interface Headers<CharSequence>

Specified by:

addLong in interface HttpHeaders

Specified by:

addLong in interface TextHeaders

Overrides:

addLong in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

addFloat

public HttpHeaders addFloat(CharSequence name,
                   float value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addFloat in interface Headers<CharSequence>

Specified by:

addFloat in interface HttpHeaders

Specified by:

addFloat in interface TextHeaders

Overrides:

addFloat in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

addDouble

public HttpHeaders addDouble(CharSequence name,
                    double value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addDouble in interface Headers<CharSequence>

Specified by:

addDouble in interface HttpHeaders

Specified by:

addDouble in interface TextHeaders

Overrides:

addDouble in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

addTimeMillis

public HttpHeaders addTimeMillis(CharSequence name,
                        long value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addTimeMillis in interface Headers<CharSequence>

Specified by:

addTimeMillis in interface HttpHeaders

Specified by:

addTimeMillis in interface TextHeaders

Overrides:

addTimeMillis in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

add

public HttpHeaders add(TextHeaders headers)

Description copied from interface: TextHeaders

See Headers.add(Headers)

Specified by:

add in interface HttpHeaders

Specified by:

add in interface TextHeaders

Overrides:

add in class DefaultTextHeaders

set

public HttpHeaders set(CharSequence name,
              CharSequence value)

Description copied from interface: Headers

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 interface Headers<CharSequence>

Specified by:

set in interface HttpHeaders

Specified by:

set in interface TextHeaders

Overrides:

set in class DefaultTextHeaders

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<? extends CharSequence> values)

Description copied from interface: Headers

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 interface Headers<CharSequence>

Specified by:

set in interface HttpHeaders

Specified by:

set in interface TextHeaders

Overrides:

set in class DefaultTextHeaders

Parameters:

name - the name of the headers being set

values - the values of the headers being set

Returns:

this

set

public HttpHeaders set(CharSequence name,
              CharSequence... values)

Description copied from interface: Headers

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 interface Headers<CharSequence>

Specified by:

set in interface HttpHeaders

Specified by:

set in interface TextHeaders

Overrides:

set in class DefaultTextHeaders

Parameters:

name - the name of the headers being set

values - the values of the headers being set

Returns:

this

setObject

public HttpHeaders setObject(CharSequence name,
                    Object value)

Description copied from interface: Headers

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:

setObject in interface Headers<CharSequence>

Specified by:

setObject in interface HttpHeaders

Specified by:

setObject in interface TextHeaders

Overrides:

setObject in class DefaultTextHeaders

Parameters:

name - The name of the header being set

value - The value of the header being set

Returns:

this

setObject

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

Description copied from interface: Headers

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:

setObject in interface Headers<CharSequence>

Specified by:

setObject in interface HttpHeaders

Specified by:

setObject in interface TextHeaders

Overrides:

setObject in class DefaultTextHeaders

Parameters:

name - the name of the headers being set

values - the values of the headers being set

Returns:

this

setObject

public HttpHeaders setObject(CharSequence name,
                    Object... values)

Description copied from interface: Headers

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:

setObject in interface Headers<CharSequence>

Specified by:

setObject in interface HttpHeaders

Specified by:

setObject in interface TextHeaders

Overrides:

setObject in class DefaultTextHeaders

Parameters:

name - the name of the headers being set

values - the values of the headers being set

Returns:

this

setBoolean

public HttpHeaders setBoolean(CharSequence name,
                     boolean value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setBoolean in interface Headers<CharSequence>

Specified by:

setBoolean in interface HttpHeaders

Specified by:

setBoolean in interface TextHeaders

Overrides:

setBoolean in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

setChar

public HttpHeaders setChar(CharSequence name,
                  char value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setChar in interface Headers<CharSequence>

Specified by:

setChar in interface HttpHeaders

Specified by:

setChar in interface TextHeaders

Overrides:

setChar in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

setByte

public HttpHeaders setByte(CharSequence name,
                  byte value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setByte in interface Headers<CharSequence>

Specified by:

setByte in interface HttpHeaders

Specified by:

setByte in interface TextHeaders

Overrides:

setByte in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

setShort

public HttpHeaders setShort(CharSequence name,
                   short value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setShort in interface Headers<CharSequence>

Specified by:

setShort in interface HttpHeaders

Specified by:

setShort in interface TextHeaders

Overrides:

setShort in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

setInt

public HttpHeaders setInt(CharSequence name,
                 int value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setInt in interface Headers<CharSequence>

Specified by:

setInt in interface HttpHeaders

Specified by:

setInt in interface TextHeaders

Overrides:

setInt in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

setLong

public HttpHeaders setLong(CharSequence name,
                  long value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setLong in interface Headers<CharSequence>

Specified by:

setLong in interface HttpHeaders

Specified by:

setLong in interface TextHeaders

Overrides:

setLong in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

setFloat

public HttpHeaders setFloat(CharSequence name,
                   float value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setFloat in interface Headers<CharSequence>

Specified by:

setFloat in interface HttpHeaders

Specified by:

setFloat in interface TextHeaders

Overrides:

setFloat in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

setDouble

public HttpHeaders setDouble(CharSequence name,
                    double value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setDouble in interface Headers<CharSequence>

Specified by:

setDouble in interface HttpHeaders

Specified by:

setDouble in interface TextHeaders

Overrides:

setDouble in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

setTimeMillis

public HttpHeaders setTimeMillis(CharSequence name,
                        long value)

Description copied from interface: Headers

Set the name to value. This will remove all previous values associated with name.

Specified by:

setTimeMillis in interface Headers<CharSequence>

Specified by:

setTimeMillis in interface HttpHeaders

Specified by:

setTimeMillis in interface TextHeaders

Overrides:

setTimeMillis in class DefaultTextHeaders

Parameters:

name - The name to modify

value - The value

Returns:

this

set

public HttpHeaders set(TextHeaders headers)

Description copied from interface: TextHeaders

See Headers.set(Headers)

Specified by:

set in interface HttpHeaders

Specified by:

set in interface TextHeaders

Overrides:

set in class DefaultTextHeaders

setAll

public HttpHeaders setAll(TextHeaders headers)

Description copied from interface: TextHeaders

See Headers.setAll(Headers)

Specified by:

setAll in interface HttpHeaders

Specified by:

setAll in interface TextHeaders

Overrides:

setAll in class DefaultTextHeaders

clear

public HttpHeaders clear()

Description copied from interface: Headers

Removes all headers.

Specified by:

clear in interface Headers<CharSequence>

Specified by:

clear in interface HttpHeaders

Specified by:

clear in interface TextHeaders

Overrides:

clear in class DefaultTextHeaders

Returns:

this