BinaryHeaders (Netty/Codec 4.1.0.Beta5 API)

All Superinterfaces:

Headers<io.netty.util.ByteString>, Iterable<Map.Entry<io.netty.util.ByteString,io.netty.util.ByteString>>

All Known Implementing Classes:

DefaultBinaryHeaders, EmptyBinaryHeaders
```
public interface BinaryHeaders
extends Headers<io.netty.util.ByteString>
```
A typical ByteString multimap used by protocols that use binary headers (such as HTTP/2) for the representation of arbitrary key-value data. ByteString is just a wrapper around a byte array but provides some additional utility when handling text data.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`BinaryHeaders.EntryVisitor` Provides an abstraction to iterate over elements maintained in the `Headers` collection.
`static interface`	`BinaryHeaders.NameVisitor` Provides an abstraction to iterate over elements maintained in the `Headers` collection.

Nested classes/interfaces inherited from interface io.netty.handler.codec.Headers
Headers.ValueConverter<T>

Method Summary

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

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

Interface BinaryHeaders

Nested Class Summary

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

Method Summary

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

Method Detail

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