TextHeaders (Netty API Reference (5.0.0.Alpha2))

All Superinterfaces:

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

All Known Subinterfaces:

HttpHeaders, SpdyHeaders, StompHeaders

All Known Implementing Classes:

DefaultHttpHeaders, DefaultSpdyHeaders, DefaultStompHeaders, DefaultTextHeaders, EmptyHttpHeaders, EmptyTextHeaders
```
public interface TextHeaders
extends ConvertibleHeaders<CharSequence,String>
```
A typical string multimap used by text protocols such as HTTP for the representation of arbitrary key-value data. One thing to note is that it uses CharSequence as its primary key and value type rather than String. When you invoke the operations that produce Strings such as Headers.get(Object), a CharSequence is implicitly converted to a String. This is particularly useful for speed optimization because this multimap can hold a special CharSequence implementation that a codec can treat specially, such as CharSequence .

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`TextHeaders.EntryVisitor` A visitor that helps reduce GC pressure while iterating over a collection of `Headers`.
`static interface`	`TextHeaders.NameVisitor` A visitor that helps reduce GC pressure while iterating over a collection of `Headers`.

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>

Method Summary

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

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

- Method Detail
  - contains
```
boolean contains(CharSequence name,
               CharSequence value,
               boolean ignoreCase)
```
    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(CharSequence name,
                     Object value,
                     boolean ignoreCase)
```
    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
  - add
```
TextHeaders 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>
    
    Parameters:
    name - the name of the header being added
    value - the value of the header being added
    
    Returns:
    this
  - add
```
TextHeaders 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>
    
    Parameters:
    name - the name of the headepublic abstract rs being set
    values - the values of the headers being set
    
    Returns:
    this
  - add
```
TextHeaders 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>
    
    Parameters:
    name - the name of the headepublic abstract rs being set
    values - the values of the headers being set
    
    Returns:
    this
  - addObject
```
TextHeaders 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>
    
    Parameters:
    name - the name of the header being added
    value - the value of the header being added
    
    Returns:
    this
  - addObject
```
TextHeaders 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>
    
    Parameters:
    name - the name of the headepublic abstract rs being set
    values - the values of the headers being set
    
    Returns:
    this
  - addObject
```
TextHeaders 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>
    
    Parameters:
    name - the name of the headepublic abstract rs being set
    values - the values of the headers being set
    
    Returns:
    this
  - addBoolean
```
TextHeaders addBoolean(CharSequence name,
                     boolean value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addBoolean in interface Headers<CharSequence>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addByte
```
TextHeaders addByte(CharSequence name,
                  byte value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addByte in interface Headers<CharSequence>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addChar
```
TextHeaders addChar(CharSequence name,
                  char value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addChar in interface Headers<CharSequence>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addShort
```
TextHeaders addShort(CharSequence name,
                   short value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addShort in interface Headers<CharSequence>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addInt
```
TextHeaders addInt(CharSequence name,
                 int value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addInt in interface Headers<CharSequence>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addLong
```
TextHeaders addLong(CharSequence name,
                  long value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addLong in interface Headers<CharSequence>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addFloat
```
TextHeaders addFloat(CharSequence name,
                   float value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addFloat in interface Headers<CharSequence>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addDouble
```
TextHeaders addDouble(CharSequence name,
                    double value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addDouble in interface Headers<CharSequence>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addTimeMillis
```
TextHeaders addTimeMillis(CharSequence name,
                        long value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addTimeMillis in interface Headers<CharSequence>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - add
```
TextHeaders add(TextHeaders headers)
```
    See Headers.add(Headers)
  - set
```
TextHeaders 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>
    
    Parameters:
    name - The name of the header being set
    value - The value of the header being set
    
    Returns:
    this
  - set
```
TextHeaders 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>
    
    Parameters:
    name - the name of the headers being set
    values - the values of the headers being set
    
    Returns:
    this
  - set
```
TextHeaders 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>
    
    Parameters:
    name - the name of the headers being set
    values - the values of the headers being set
    
    Returns:
    this
  - setObject
```
TextHeaders 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>
    
    Parameters:
    name - The name of the header being set
    value - The value of the header being set
    
    Returns:
    this
  - setObject
```
TextHeaders 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>
    
    Parameters:
    name - the name of the headers being set
    values - the values of the headers being set
    
    Returns:
    this
  - setObject
```
TextHeaders 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>
    
    Parameters:
    name - the name of the headers being set
    values - the values of the headers being set
    
    Returns:
    this
  - setBoolean
```
TextHeaders 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>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setByte
```
TextHeaders 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>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setChar
```
TextHeaders 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>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setShort
```
TextHeaders 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>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setInt
```
TextHeaders 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>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setLong
```
TextHeaders 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>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setFloat
```
TextHeaders 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>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setDouble
```
TextHeaders 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>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setTimeMillis
```
TextHeaders 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>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - set
```
TextHeaders set(TextHeaders headers)
```
    See Headers.set(Headers)
  - setAll
```
TextHeaders setAll(TextHeaders headers)
```
    See Headers.setAll(Headers)
  - clear
```
TextHeaders clear()
```
    Description copied from interface: Headers
    
    Removes all headers.
    
    Specified by:
    
    clear in interface Headers<CharSequence>
    
    Returns:
    this

Interface TextHeaders

Nested Class Summary

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

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

Method Summary

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

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

Method Detail

contains

containsObject

add

add

add

addObject

addObject

addObject

addBoolean

addByte

addChar

addShort

addInt

addLong

addFloat

addDouble

addTimeMillis

add

set

set

set

setObject

setObject

setObject

setBoolean

setByte

setChar

setShort

setInt

setLong

setFloat

setDouble

setTimeMillis

set

setAll

clear