Headers (Netty API Reference (5.0.0.Alpha2))

All Superinterfaces:

Iterable<Map.Entry<T,T>>

All Known Subinterfaces:

BinaryHeaders, ConvertibleHeaders<UnconvertedType,ConvertedType>, Http2Headers, HttpHeaders, SpdyHeaders, StompHeaders, TextHeaders

All Known Implementing Classes:

DefaultBinaryHeaders, DefaultConvertibleHeaders, DefaultHeaders, DefaultHttp2Headers, DefaultHttpHeaders, DefaultSpdyHeaders, DefaultStompHeaders, DefaultTextHeaders, EmptyBinaryHeaders, EmptyConvertibleHeaders, EmptyHeaders, EmptyHttp2Headers, EmptyHttpHeaders, EmptyTextHeaders
```
public interface Headers<T>
extends Iterable<Map.Entry<T,T>>
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Headers.EntryVisitor<T>` A visitor that helps reduce GC pressure while iterating over a collection of `Headers`.
`static interface`	`Headers.NameVisitor<T>` A visitor that helps reduce GC pressure while iterating over a collection of `Headers`.
`static interface`	`Headers.ValueConverter<T>` Converts to/from a generic object to the type of the name for this map

Method Summary

Methods
Modifier and Type	Method and Description
`Headers<T>`	`add(Headers<T> headers)` Adds all header entries of the specified `headers`.
`Headers<T>`	`add(T name, Iterable<? extends T> values)` Adds a new header with the specified name and values.
`Headers<T>`	`add(T name, T... values)` Adds a new header with the specified name and values.
`Headers<T>`	`add(T name, T value)` Adds a new header with the specified name and value.
`Headers<T>`	`addBoolean(T name, boolean value)` Add the `name` to `value`.
`Headers<T>`	`addByte(T name, byte value)` Add the `name` to `value`.
`Headers<T>`	`addChar(T name, char value)` Add the `name` to `value`.
`Headers<T>`	`addDouble(T name, double value)` Add the `name` to `value`.
`Headers<T>`	`addFloat(T name, float value)` Add the `name` to `value`.
`Headers<T>`	`addInt(T name, int value)` Add the `name` to `value`.
`Headers<T>`	`addLong(T name, long value)` Add the `name` to `value`.
`Headers<T>`	`addObject(T name, Iterable<?> values)` Adds a new header with the specified name and values.
`Headers<T>`	`addObject(T name, Object... values)` Adds a new header with the specified name and values.
`Headers<T>`	`addObject(T name, Object value)` Adds a new header with the specified name and value.
`Headers<T>`	`addShort(T name, short value)` Add the `name` to `value`.
`Headers<T>`	`addTimeMillis(T name, long value)` Add the `name` to `value`.
`Headers<T>`	`clear()` Removes all headers.
`boolean`	`contains(T name)` Returns `true` if and only if this collection contains the header with the specified name.
`boolean`	`contains(T name, T value)` Returns `true` if a header with the name and value exists.
`boolean`	`contains(T name, T value, Comparator<? super T> comparator)` Returns `true` if a header with the name and value exists.
`boolean`	`contains(T name, T value, Comparator<? super T> keyComparator, Comparator<? super T> valueComparator)` Returns `true` if a header with the name and value exists.
`boolean`	`containsBoolean(T name, boolean value)` Returns `true` if a header with the name and value exists.
`boolean`	`containsByte(T name, byte value)` Returns `true` if a header with the name and value exists.
`boolean`	`containsChar(T name, char value)` Returns `true` if a header with the name and value exists.
`boolean`	`containsDouble(T name, double value)` Returns `true` if a header with the name and value exists.
`boolean`	`containsFloat(T name, float value)` Returns `true` if a header with the name and value exists.
`boolean`	`containsInt(T name, int value)` Returns `true` if a header with the name and value exists.
`boolean`	`containsLong(T name, long value)` Returns `true` if a header with the name and value exists.
`boolean`	`containsObject(T name, Object value)` Returns `true` if a header with the name and value exists.
`boolean`	`containsObject(T name, Object value, Comparator<? super T> comparator)` Returns `true` if a header with the name and value exists.
`boolean`	`containsObject(T name, Object value, Comparator<? super T> keyComparator, Comparator<? super T> valueComparator)` Returns `true` if a header with the name and value exists.
`boolean`	`containsShort(T name, short value)` Returns `true` if a header with the name and value exists.
`boolean`	`containsTimeMillis(T name, long value)` Returns `true` if a header with the name and value exists.
`List<Map.Entry<T,T>>`	`entries()` Returns a new `List` that contains all headers in this object.
`Map.Entry<T,T>`	`forEachEntry(Headers.EntryVisitor<T> visitor)` Provide a means of iterating over elements in this map with low GC
`T`	`forEachName(Headers.NameVisitor<T> visitor)` Provide a means of iterating over elements in this map with low GC
`T`	`get(T name)` Returns the value of a header with the specified name.
`T`	`get(T name, T defaultValue)` Returns the value of a header with the specified name.
`List<T>`	`getAll(T name)` Returns the values of headers with the specified name
`List<T>`	`getAllAndRemove(T name)` Returns and Removes the values of headers with the specified name
`T`	`getAndRemove(T name)` Returns and removes the value of a header with the specified name.
`T`	`getAndRemove(T name, T defaultValue)` Returns and removes the value of a header with the specified name.
`Boolean`	`getBoolean(T name)` Returns the boolean value of a header with the specified name.
`boolean`	`getBoolean(T name, boolean defaultValue)` Returns the boolean value of a header with the specified name.
`Boolean`	`getBooleanAndRemove(T name)` Returns and removes the boolean value of a header with the specified name.
`boolean`	`getBooleanAndRemove(T name, boolean defaultValue)` Returns and removes the boolean value of a header with the specified name.
`Byte`	`getByte(T name)` Returns the byte value of a header with the specified name.
`byte`	`getByte(T name, byte defaultValue)` Returns the byte value of a header with the specified name.
`Byte`	`getByteAndRemove(T name)` Returns and removes the byte value of a header with the specified name.
`byte`	`getByteAndRemove(T name, byte defaultValue)` Returns and removes the byte value of a header with the specified name.
`Character`	`getChar(T name)` Returns the char value of a header with the specified name.
`char`	`getChar(T name, char defaultValue)` Returns the char value of a header with the specified name.
`Character`	`getCharAndRemove(T name)` Returns and removes the char value of a header with the specified name.
`char`	`getCharAndRemove(T name, char defaultValue)` Returns and removes the char value of a header with the specified name.
`Double`	`getDouble(T name)` Returns the double value of a header with the specified name.
`double`	`getDouble(T name, double defaultValue)` Returns the double value of a header with the specified name.
`Double`	`getDoubleAndRemove(T name)` Returns and removes the double value of a header with the specified name.
`double`	`getDoubleAndRemove(T name, double defaultValue)` Returns and removes the double value of a header with the specified name.
`Float`	`getFloat(T name)` Returns the float value of a header with the specified name.
`float`	`getFloat(T name, float defaultValue)` Returns the float value of a header with the specified name.
`Float`	`getFloatAndRemove(T name)` Returns and removes the float value of a header with the specified name.
`float`	`getFloatAndRemove(T name, float defaultValue)` Returns and removes the float value of a header with the specified name.
`Integer`	`getInt(T name)` Returns the integer value of a header with the specified name.
`int`	`getInt(T name, int defaultValue)` Returns the integer value of a header with the specified name.
`short`	`getInt(T name, short defaultValue)` Returns the short value of a header with the specified name.
`Integer`	`getIntAndRemove(T name)` Returns and removes the integer value of a header with the specified name.
`int`	`getIntAndRemove(T name, int defaultValue)` Returns and removes the integer value of a header with the specified name.
`Long`	`getLong(T name)` Returns the long value of a header with the specified name.
`long`	`getLong(T name, long defaultValue)` Returns the long value of a header with the specified name.
`Long`	`getLongAndRemove(T name)` Returns and removes the long value of a header with the specified name.
`long`	`getLongAndRemove(T name, long defaultValue)` Returns and removes the long value of a header with the specified name.
`Short`	`getShort(T name)` Returns the short value of a header with the specified name.
`Short`	`getShortAndRemove(T name)` Returns and removes the short value of a header with the specified name.
`short`	`getShortAndRemove(T name, short defaultValue)` Returns and removes the short value of a header with the specified name.
`Long`	`getTimeMillis(T name)` Returns the date value of a header with the specified name as milliseconds.
`long`	`getTimeMillis(T name, long defaultValue)` Returns the date value of a header with the specified name as milliseconds.
`Long`	`getTimeMillisAndRemove(T name)` Returns and removes the date value of a header with the specified name as milliseconds.
`long`	`getTimeMillisAndRemove(T name, long defaultValue)` Returns and removes the date value of a header with the specified name as milliseconds.
`boolean`	`isEmpty()` Returns `true` if and only if this collection contains no header entries.
`Iterator<Map.Entry<T,T>>`	`iterator()`
`Set<T>`	`names()` Returns a new `Set` that contains the names of all headers in this object.
`List<T>`	`namesList()` Returns a new `List` that contains the names of all headers in this object.
`boolean`	`remove(T name)` Removes the header with the specified name.
`Headers<T>`	`set(Headers<T> headers)` Cleans the current header entries and copies all header entries of the specified `headers`.
`Headers<T>`	`set(T name, Iterable<? extends T> values)` Sets a header with the specified name and values.
`Headers<T>`	`set(T name, T... values)` Sets a header with the specified name and values.
`Headers<T>`	`set(T name, T value)` Sets a header with the specified name and value.
`Headers<T>`	`setAll(Headers<T> headers)` Retains all current headers but calls `set(Object, Object)` for each entry in `headers`
`Headers<T>`	`setBoolean(T name, boolean value)` Set the `name` to `value`.
`Headers<T>`	`setByte(T name, byte value)` Set the `name` to `value`.
`Headers<T>`	`setChar(T name, char value)` Set the `name` to `value`.
`Headers<T>`	`setDouble(T name, double value)` Set the `name` to `value`.
`Headers<T>`	`setFloat(T name, float value)` Set the `name` to `value`.
`Headers<T>`	`setInt(T name, int value)` Set the `name` to `value`.
`Headers<T>`	`setLong(T name, long value)` Set the `name` to `value`.
`Headers<T>`	`setObject(T name, Iterable<?> values)` Sets a header with the specified name and values.
`Headers<T>`	`setObject(T name, Object... values)` Sets a header with the specified name and values.
`Headers<T>`	`setObject(T name, Object value)` Sets a header with the specified name and value.
`Headers<T>`	`setShort(T name, short value)` Set the `name` to `value`.
`Headers<T>`	`setTimeMillis(T name, long value)` Set the `name` to `value`.
`int`	`size()` Returns the number of header entries in this collection.

- Method Detail
  - get
```
T get(T name)
```
    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.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found. null if there's no such header.
  - get
```
T get(T name,
    T defaultValue)
```
    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.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found. defaultValue if there's no such header.
  - getAndRemove
```
T getAndRemove(T name)
```
    Returns and removes 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.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value or null if there is no such header
  - getAndRemove
```
T getAndRemove(T name,
             T defaultValue)
```
    Returns and removes 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.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value or defaultValue if there is no such header
  - getAll
```
List<T> getAll(T name)
```
    Returns the values of headers with the specified name
    
    Parameters:
    name - The name of the headers to search
    
    Returns:
    A List of header values which will be empty if no values are found
  - getAllAndRemove
```
List<T> getAllAndRemove(T name)
```
    Returns and Removes the values of headers with the specified name
    
    Parameters:
    name - The name of the headers to search
    
    Returns:
    A List of header values which will be empty if no values are found
  - getBoolean
```
Boolean getBoolean(T name)
```
    Returns the boolean value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found and its value is a boolean. null if there's no such header or its value is not a boolean.
  - getBoolean
```
boolean getBoolean(T name,
                 boolean defaultValue)
```
    Returns the boolean value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found and its value is a boolean. defaultValue if there's no such header or its value is not a boolean.
  - getByte
```
Byte getByte(T name)
```
    Returns the byte value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found and its value is a byte. null if there's no such header or its value is not a byte.
  - getByte
```
byte getByte(T name,
           byte defaultValue)
```
    Returns the byte value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found and its value is a byte. defaultValue if there's no such header or its value is not a byte.
  - getChar
```
Character getChar(T name)
```
    Returns the char value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found and its value is a char. null if there's no such header or its value is not a char.
  - getChar
```
char getChar(T name,
           char defaultValue)
```
    Returns the char value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found and its value is a char. defaultValue if there's no such header or its value is not a char.
  - getShort
```
Short getShort(T name)
```
    Returns the short value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found and its value is a short. null if there's no such header or its value is not a short.
  - getInt
```
short getInt(T name,
           short defaultValue)
```
    Returns the short value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found and its value is a short. defaultValue if there's no such header or its value is not a short.
  - getInt
```
Integer getInt(T name)
```
    Returns the integer value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found and its value is an integer. null if there's no such header or its value is not an integer.
  - getInt
```
int getInt(T name,
         int defaultValue)
```
    Returns the integer value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found and its value is an integer. defaultValue if there's no such header or its value is not an integer.
  - getLong
```
Long getLong(T name)
```
    Returns the long value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found and its value is a long. null if there's no such header or its value is not a long.
  - getLong
```
long getLong(T name,
           long defaultValue)
```
    Returns the long value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found and its value is a long. defaultValue if there's no such header or its value is not a long.
  - getFloat
```
Float getFloat(T name)
```
    Returns the float value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found and its value is a float. null if there's no such header or its value is not a float.
  - getFloat
```
float getFloat(T name,
             float defaultValue)
```
    Returns the float value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found and its value is a float. defaultValue if there's no such header or its value is not a float.
  - getDouble
```
Double getDouble(T name)
```
    Returns the double value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found and its value is a double. null if there's no such header or its value is not a double.
  - getDouble
```
double getDouble(T name,
               double defaultValue)
```
    Returns the double value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found and its value is a double. defaultValue if there's no such header or its value is not a double.
  - getTimeMillis
```
Long getTimeMillis(T name)
```
    Returns the date value of a header with the specified name as milliseconds. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - The name of the header to search
    
    Returns:
    the first header value in milliseconds if the header is found and its value is a date. null if there's no such header or its value is not a date.
  - getTimeMillis
```
long getTimeMillis(T name,
                 long defaultValue)
```
    Returns the date value of a header with the specified name as milliseconds. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - The name of the header to search
    defaultValue - default value
    
    Returns:
    the first header value in milliseconds if the header is found and its value is a date. defaultValue if there's no such header or its value is not a date.
  - getBooleanAndRemove
```
Boolean getBooleanAndRemove(T name)
```
    Returns and removes the boolean value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found and its value is a boolean. null if there's no such header or its value is not a boolean.
  - getBooleanAndRemove
```
boolean getBooleanAndRemove(T name,
                          boolean defaultValue)
```
    Returns and removes the boolean value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found and its value is a boolean. defaultValue if there is no such header or its value of header is not a boolean.
  - getByteAndRemove
```
Byte getByteAndRemove(T name)
```
    Returns and removes the byte value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found and its value is a byte. null if there's no such header or its value is not a byte.
  - getByteAndRemove
```
byte getByteAndRemove(T name,
                    byte defaultValue)
```
    Returns and removes the byte value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found and its value is a byte. defaultValue if there is no such header or its value of header is not a byte.
  - getCharAndRemove
```
Character getCharAndRemove(T name)
```
    Returns and removes the char value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found and its value is a char. null if there's no such header or its value is not a char.
  - getCharAndRemove
```
char getCharAndRemove(T name,
                    char defaultValue)
```
    Returns and removes the char value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found and its value is a char. defaultValue if there is no such header or its value of header is not a char.
  - getShortAndRemove
```
Short getShortAndRemove(T name)
```
    Returns and removes the short value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found and its value is a short. null if there's no such header or its value is not a short.
  - getShortAndRemove
```
short getShortAndRemove(T name,
                      short defaultValue)
```
    Returns and removes the short value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found and its value is a short. defaultValue if there is no such header or its value of header is not a short.
  - getIntAndRemove
```
Integer getIntAndRemove(T name)
```
    Returns and removes the integer value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found and its value is an integer. null if there's no such header or its value is not an integer.
  - getIntAndRemove
```
int getIntAndRemove(T name,
                  int defaultValue)
```
    Returns and removes the integer value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found and its value is an integer. defaultValue if there is no such header or its value of header is not an integer.
  - getLongAndRemove
```
Long getLongAndRemove(T name)
```
    Returns and removes the long value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found and its value is a long. null if there's no such header or its value is not a long.
  - getLongAndRemove
```
long getLongAndRemove(T name,
                    long defaultValue)
```
    Returns and removes the long value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found and its value is a long. defaultValue if there's no such header or its value is not a long.
  - getFloatAndRemove
```
Float getFloatAndRemove(T name)
```
    Returns and removes the float value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found and its value is a float. null if there's no such header or its value is not a float.
  - getFloatAndRemove
```
float getFloatAndRemove(T name,
                      float defaultValue)
```
    Returns and removes the float value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found and its value is a float. defaultValue if there's no such header or its value is not a float.
  - getDoubleAndRemove
```
Double getDoubleAndRemove(T name)
```
    Returns and removes the double value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    
    Returns:
    the first header value if the header is found and its value is a double. null if there's no such header or its value is not a double.
  - getDoubleAndRemove
```
double getDoubleAndRemove(T name,
                        double defaultValue)
```
    Returns and removes the double value of a header with the specified name. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - the name of the header to search
    defaultValue - the default value
    
    Returns:
    the first header value if the header is found and its value is a double. defaultValue if there's no such header or its value is not a double.
  - getTimeMillisAndRemove
```
Long getTimeMillisAndRemove(T name)
```
    Returns and removes the date value of a header with the specified name as milliseconds. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - The name of the header to search
    
    Returns:
    the first header value in milliseconds if the header is found and its value is a date. null if there's no such header or its value is not a date.
  - getTimeMillisAndRemove
```
long getTimeMillisAndRemove(T name,
                          long defaultValue)
```
    Returns and removes the date value of a header with the specified name as milliseconds. If there are more than one values for the specified name, the first value is returned.
    
    Parameters:
    name - The name of the header to search
    defaultValue - default value
    
    Returns:
    the first header value in milliseconds if the header is found and its value is a date. defaultValue if there's no such header or its value is not a date.
  - entries
```
List<Map.Entry<T,T>> entries()
```
    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 iterator() instead, which has much less overhead.
  - contains
```
boolean contains(T name)
```
    Returns true if and only if this collection contains the header with the specified name.
    
    Parameters:
    name - The name of the header to search for
    
    Returns:
    true if at least one header is found
  - contains
```
boolean contains(T name,
               T value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    name - the header name
    value - the header value
    
    Returns:
    true if it contains it false otherwise
  - containsObject
```
boolean containsObject(T name,
                     Object value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    name - the header name
    value - the header value
    
    Returns:
    true if it contains it false otherwise
  - containsBoolean
```
boolean containsBoolean(T name,
                      boolean value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    name - the header name
    value - the header value
    
    Returns:
    true if it contains it false otherwise
  - containsByte
```
boolean containsByte(T name,
                   byte value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    name - the header name
    value - the header value
    
    Returns:
    true if it contains it false otherwise
  - containsChar
```
boolean containsChar(T name,
                   char value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    name - the header name
    value - the header value
    
    Returns:
    true if it contains it false otherwise
  - containsShort
```
boolean containsShort(T name,
                    short value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    name - the header name
    value - the header value
    
    Returns:
    true if it contains it false otherwise
  - containsInt
```
boolean containsInt(T name,
                  int value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    name - the header name
    value - the header value
    
    Returns:
    true if it contains it false otherwise
  - containsLong
```
boolean containsLong(T name,
                   long value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    name - the header name
    value - the header value
    
    Returns:
    true if it contains it false otherwise
  - containsFloat
```
boolean containsFloat(T name,
                    float value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    name - the header name
    value - the header value
    
    Returns:
    true if it contains it false otherwise
  - containsDouble
```
boolean containsDouble(T name,
                     double value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    name - the header name
    value - the header value
    
    Returns:
    true if it contains it false otherwise
  - containsTimeMillis
```
boolean containsTimeMillis(T name,
                         long value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    name - the header name
    value - the header value
    
    Returns:
    true if it contains it false otherwise
  - contains
```
boolean contains(T name,
               T value,
               Comparator<? super T> comparator)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    name - the header name
    value - the header value
    comparator - The comparator to use when comparing name and value to entries in this map
    
    Returns:
    true if it contains it false otherwise
  - contains
```
boolean contains(T name,
               T value,
               Comparator<? super T> keyComparator,
               Comparator<? super T> valueComparator)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    name - the header name
    value - the header value
    keyComparator - The comparator to use when comparing name to names in this map
    valueComparator - The comparator to use when comparing value to values in this map
    
    Returns:
    true if it contains it false otherwise
  - containsObject
```
boolean containsObject(T name,
                     Object value,
                     Comparator<? super T> comparator)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    name - the header name
    value - the header value
    comparator - The comparator to use when comparing name and value to entries in this map
    
    Returns:
    true if it contains it false otherwise
  - containsObject
```
boolean containsObject(T name,
                     Object value,
                     Comparator<? super T> keyComparator,
                     Comparator<? super T> valueComparator)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    name - the header name
    value - the header value
    keyComparator - The comparator to use when comparing name to names in this map
    valueComparator - The comparator to use when comparing value to values in this map
    
    Returns:
    true if it contains it false otherwise
  - size
```
int size()
```
    Returns the number of header entries in this collection.
  - isEmpty
```
boolean isEmpty()
```
    Returns true if and only if this collection contains no header entries.
  - names
```
Set<T> names()
```
    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 iterator() instead, which has much less overhead.
  - namesList
```
List<T> namesList()
```
    Returns a new List that contains the names of 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 iterator() instead, which has much less overhead.
  - add
```
Headers<T> add(T name,
             T value)
```
    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.
    
    Parameters:
    name - the name of the header being added
    value - the value of the header being added
    
    Returns:
    this
  - add
```
Headers<T> add(T name,
             Iterable<? extends T> values)
```
    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);
 }
 
```
    Parameters:
    name - the name of the headepublic abstract rs being set
    values - the values of the headers being set
    
    Returns:
    this
  - add
```
Headers<T> add(T name,
             T... values)
```
    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);
 }
 
```
    Parameters:
    name - the name of the headepublic abstract rs being set
    values - the values of the headers being set
    
    Returns:
    this
  - addObject
```
Headers<T> addObject(T name,
                   Object value)
```
    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.
    
    Parameters:
    name - the name of the header being added
    value - the value of the header being added
    
    Returns:
    this
  - addObject
```
Headers<T> addObject(T name,
                   Iterable<?> values)
```
    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);
 }
 
```
    Parameters:
    name - the name of the headepublic abstract rs being set
    values - the values of the headers being set
    
    Returns:
    this
  - addObject
```
Headers<T> addObject(T name,
                   Object... values)
```
    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);
 }
 
```
    Parameters:
    name - the name of the headepublic abstract rs being set
    values - the values of the headers being set
    
    Returns:
    this
  - addBoolean
```
Headers<T> addBoolean(T name,
                    boolean value)
```
    Add the name to value.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addByte
```
Headers<T> addByte(T name,
                 byte value)
```
    Add the name to value.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addChar
```
Headers<T> addChar(T name,
                 char value)
```
    Add the name to value.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addShort
```
Headers<T> addShort(T name,
                  short value)
```
    Add the name to value.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addInt
```
Headers<T> addInt(T name,
                int value)
```
    Add the name to value.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addLong
```
Headers<T> addLong(T name,
                 long value)
```
    Add the name to value.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addFloat
```
Headers<T> addFloat(T name,
                  float value)
```
    Add the name to value.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addDouble
```
Headers<T> addDouble(T name,
                   double value)
```
    Add the name to value.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addTimeMillis
```
Headers<T> addTimeMillis(T name,
                       long value)
```
    Add the name to value.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - add
```
Headers<T> add(Headers<T> headers)
```
    Adds all header entries of the specified headers.
    
    Returns:
    this
  - set
```
Headers<T> set(T name,
             T value)
```
    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.
    
    Parameters:
    name - The name of the header being set
    value - The value of the header being set
    
    Returns:
    this
  - set
```
Headers<T> set(T name,
             Iterable<? extends T> values)
```
    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);
 }
 
```
    Parameters:
    name - the name of the headers being set
    values - the values of the headers being set
    
    Returns:
    this
  - set
```
Headers<T> set(T name,
             T... values)
```
    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);
 }
 
```
    Parameters:
    name - the name of the headers being set
    values - the values of the headers being set
    
    Returns:
    this
  - setObject
```
Headers<T> setObject(T name,
                   Object value)
```
    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.
    
    Parameters:
    name - The name of the header being set
    value - The value of the header being set
    
    Returns:
    this
  - setObject
```
Headers<T> setObject(T name,
                   Iterable<?> values)
```
    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);
 }
 
```
    Parameters:
    name - the name of the headers being set
    values - the values of the headers being set
    
    Returns:
    this
  - setObject
```
Headers<T> setObject(T name,
                   Object... values)
```
    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);
 }
 
```
    Parameters:
    name - the name of the headers being set
    values - the values of the headers being set
    
    Returns:
    this
  - setBoolean
```
Headers<T> setBoolean(T name,
                    boolean value)
```
    Set the name to value. This will remove all previous values associated with name.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setByte
```
Headers<T> setByte(T name,
                 byte value)
```
    Set the name to value. This will remove all previous values associated with name.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setChar
```
Headers<T> setChar(T name,
                 char value)
```
    Set the name to value. This will remove all previous values associated with name.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setShort
```
Headers<T> setShort(T name,
                  short value)
```
    Set the name to value. This will remove all previous values associated with name.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setInt
```
Headers<T> setInt(T name,
                int value)
```
    Set the name to value. This will remove all previous values associated with name.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setLong
```
Headers<T> setLong(T name,
                 long value)
```
    Set the name to value. This will remove all previous values associated with name.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setFloat
```
Headers<T> setFloat(T name,
                  float value)
```
    Set the name to value. This will remove all previous values associated with name.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setDouble
```
Headers<T> setDouble(T name,
                   double value)
```
    Set the name to value. This will remove all previous values associated with name.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setTimeMillis
```
Headers<T> setTimeMillis(T name,
                       long value)
```
    Set the name to value. This will remove all previous values associated with name.
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - set
```
Headers<T> set(Headers<T> headers)
```
    Cleans the current header entries and copies all header entries of the specified headers.
    
    Returns:
    this
  - setAll
```
Headers<T> setAll(Headers<T> headers)
```
    Retains all current headers but calls set(Object, Object) for each entry in headers
    
    Parameters:
    headers - The headers used to set(Object, Object) values in this instance
    
    Returns:
    this
  - remove
```
boolean remove(T name)
```
    Removes the header with the specified name.
    
    Parameters:
    name - The name of the header to remove
    
    Returns:
    true if and only if at least one entry has been removed
  - clear
```
Headers<T> clear()
```
    Removes all headers.
    
    Returns:
    this
  - iterator
```
Iterator<Map.Entry<T,T>> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Map.Entry<T,T>>
  - forEachEntry
```
Map.Entry<T,T> forEachEntry(Headers.EntryVisitor<T> visitor)
                            throws Exception
```
    Provide a means of iterating over elements in this map with low GC
    
    Parameters:
    visitor - The visitor which will visit each element in this map
    
    Returns:
    The last entry before iteration stopped or null if iteration went past the end
    
    Throws:
    
    Exception
  - forEachName
```
T forEachName(Headers.NameVisitor<T> visitor)
              throws Exception
```
    Provide a means of iterating over elements in this map with low GC
    
    Parameters:
    visitor - The visitor which will visit each element in this map
    
    Returns:
    The last key before iteration stopped or null if iteration went past the end
    
    Throws:
    
    Exception

Interface Headers<T>

Nested Class Summary

Method Summary

Method Detail

get

get

getAndRemove

getAndRemove

getAll

getAllAndRemove

getBoolean

getBoolean

getByte

getByte

getChar

getChar

getShort

getInt

getInt

getInt

getLong

getLong

getFloat

getFloat

getDouble

getDouble

getTimeMillis

getTimeMillis

getBooleanAndRemove

getBooleanAndRemove

getByteAndRemove

getByteAndRemove

getCharAndRemove

getCharAndRemove

getShortAndRemove

getShortAndRemove

getIntAndRemove

getIntAndRemove

getLongAndRemove

getLongAndRemove

getFloatAndRemove

getFloatAndRemove

getDoubleAndRemove

getDoubleAndRemove

getTimeMillisAndRemove

getTimeMillisAndRemove

entries

contains

contains

containsObject

containsBoolean

containsByte

containsChar

containsShort

containsInt

containsLong

containsFloat

containsDouble

containsTimeMillis

contains

contains

containsObject

containsObject

size

isEmpty

names

namesList

add

add

add

addObject

addObject

addObject

addBoolean

addByte

addChar

addShort

addInt

addLong

addFloat