Http2Headers (Netty API Reference (5.0.0.Alpha2))

All Superinterfaces:

BinaryHeaders, Headers<AsciiString>, Iterable<Map.Entry<AsciiString,AsciiString>>

All Known Implementing Classes:

DefaultHttp2Headers, EmptyHttp2Headers
```
public interface Http2Headers
extends BinaryHeaders
```
A collection of headers sent or received via HTTP/2.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Http2Headers.PseudoHeaderName
HTTP/2 pseudo-headers names.
- Nested classes/interfaces inherited from interface io.netty.handler.codec.BinaryHeaders
  BinaryHeaders.EntryVisitor, BinaryHeaders.NameVisitor
- Nested classes/interfaces inherited from interface io.netty.handler.codec.Headers
  Headers.ValueConverter<T>

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Http2Headers.PseudoHeaderName` HTTP/2 pseudo-headers names.

Method Summary

Methods
Modifier and Type	Method and Description
`Http2Headers`	`add(AsciiString name, AsciiString... values)` Adds a new header with the specified name and values.
`Http2Headers`	`add(AsciiString name, AsciiString value)` Adds a new header with the specified name and value.
`Http2Headers`	`add(AsciiString name, Iterable<? extends AsciiString> values)` Adds a new header with the specified name and values.
`Http2Headers`	`add(BinaryHeaders headers)` See `Headers.add(Headers)`
`Http2Headers`	`addBoolean(AsciiString name, boolean value)` Add the `name` to `value`.
`Http2Headers`	`addByte(AsciiString name, byte value)` Add the `name` to `value`.
`Http2Headers`	`addChar(AsciiString name, char value)` Add the `name` to `value`.
`Http2Headers`	`addDouble(AsciiString name, double value)` Add the `name` to `value`.
`Http2Headers`	`addFloat(AsciiString name, float value)` Add the `name` to `value`.
`Http2Headers`	`addInt(AsciiString name, int value)` Add the `name` to `value`.
`Http2Headers`	`addLong(AsciiString name, long value)` Add the `name` to `value`.
`Http2Headers`	`addObject(AsciiString name, Iterable<?> values)` Adds a new header with the specified name and values.
`Http2Headers`	`addObject(AsciiString name, Object... values)` Adds a new header with the specified name and values.
`Http2Headers`	`addObject(AsciiString name, Object value)` Adds a new header with the specified name and value.
`Http2Headers`	`addShort(AsciiString name, short value)` Add the `name` to `value`.
`Http2Headers`	`addTimeMillis(AsciiString name, long value)` Add the `name` to `value`.
`AsciiString`	`authority()` Gets the `Http2Headers.PseudoHeaderName.AUTHORITY` header or `null` if there is no such header
`Http2Headers`	`authority(AsciiString value)` Sets the `Http2Headers.PseudoHeaderName.AUTHORITY` header or `null` if there is no such header
`Http2Headers`	`clear()` Removes all headers.
`AsciiString`	`method()` Gets the `Http2Headers.PseudoHeaderName.METHOD` header or `null` if there is no such header
`Http2Headers`	`method(AsciiString value)` Sets the `Http2Headers.PseudoHeaderName.METHOD` header or `null` if there is no such header
`AsciiString`	`path()` Gets the `Http2Headers.PseudoHeaderName.PATH` header or `null` if there is no such header
`Http2Headers`	`path(AsciiString value)` Sets the `Http2Headers.PseudoHeaderName.PATH` header or `null` if there is no such header
`AsciiString`	`scheme()` Gets the `Http2Headers.PseudoHeaderName.SCHEME` header or `null` if there is no such header
`Http2Headers`	`scheme(AsciiString value)` Sets the `Http2Headers.PseudoHeaderName.SCHEME` header if there is no such header
`Http2Headers`	`set(AsciiString name, AsciiString... values)` Sets a header with the specified name and values.
`Http2Headers`	`set(AsciiString name, AsciiString value)` Sets a header with the specified name and value.
`Http2Headers`	`set(AsciiString name, Iterable<? extends AsciiString> values)` Sets a header with the specified name and values.
`Http2Headers`	`set(BinaryHeaders headers)` See `Headers.set(Headers)`
`Http2Headers`	`setAll(BinaryHeaders headers)` See `Headers.setAll(Headers)`
`Http2Headers`	`setBoolean(AsciiString name, boolean value)` Set the `name` to `value`.
`Http2Headers`	`setByte(AsciiString name, byte value)` Set the `name` to `value`.
`Http2Headers`	`setChar(AsciiString name, char value)` Set the `name` to `value`.
`Http2Headers`	`setDouble(AsciiString name, double value)` Set the `name` to `value`.
`Http2Headers`	`setFloat(AsciiString name, float value)` Set the `name` to `value`.
`Http2Headers`	`setInt(AsciiString name, int value)` Set the `name` to `value`.
`Http2Headers`	`setLong(AsciiString name, long value)` Set the `name` to `value`.
`Http2Headers`	`setObject(AsciiString name, Iterable<?> values)` Sets a header with the specified name and values.
`Http2Headers`	`setObject(AsciiString name, Object... values)` Sets a header with the specified name and values.
`Http2Headers`	`setObject(AsciiString name, Object value)` Sets a header with the specified name and value.
`Http2Headers`	`setShort(AsciiString name, short value)` Set the `name` to `value`.
`Http2Headers`	`setTimeMillis(AsciiString name, long value)` Set the `name` to `value`.
`AsciiString`	`status()` Gets the `Http2Headers.PseudoHeaderName.STATUS` header or `null` if there is no such header
`Http2Headers`	`status(AsciiString value)` Sets the `Http2Headers.PseudoHeaderName.STATUS` header or `null` if there is no such header

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
```
Http2Headers add(AsciiString name,
               AsciiString 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 BinaryHeaders
    
    Specified by:
    
    add in interface Headers<AsciiString>
    
    Parameters:
    name - the name of the header being added
    value - the value of the header being added
    
    Returns:
    this
  - add
```
Http2Headers add(AsciiString name,
               Iterable<? extends AsciiString> 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 BinaryHeaders
    
    Specified by:
    
    add in interface Headers<AsciiString>
    
    Parameters:
    name - the name of the headepublic abstract rs being set
    values - the values of the headers being set
    
    Returns:
    this
  - add
```
Http2Headers add(AsciiString name,
               AsciiString... 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 BinaryHeaders
    
    Specified by:
    
    add in interface Headers<AsciiString>
    
    Parameters:
    name - the name of the headepublic abstract rs being set
    values - the values of the headers being set
    
    Returns:
    this
  - addObject
```
Http2Headers addObject(AsciiString 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 BinaryHeaders
    
    Specified by:
    
    addObject in interface Headers<AsciiString>
    
    Parameters:
    name - the name of the header being added
    value - the value of the header being added
    
    Returns:
    this
  - addObject
```
Http2Headers addObject(AsciiString 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 BinaryHeaders
    
    Specified by:
    
    addObject in interface Headers<AsciiString>
    
    Parameters:
    name - the name of the headepublic abstract rs being set
    values - the values of the headers being set
    
    Returns:
    this
  - addObject
```
Http2Headers addObject(AsciiString 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 BinaryHeaders
    
    Specified by:
    
    addObject in interface Headers<AsciiString>
    
    Parameters:
    name - the name of the headepublic abstract rs being set
    values - the values of the headers being set
    
    Returns:
    this
  - addBoolean
```
Http2Headers addBoolean(AsciiString name,
                      boolean value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addBoolean in interface BinaryHeaders
    
    Specified by:
    
    addBoolean in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addByte
```
Http2Headers addByte(AsciiString name,
                   byte value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addByte in interface BinaryHeaders
    
    Specified by:
    
    addByte in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addChar
```
Http2Headers addChar(AsciiString name,
                   char value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addChar in interface BinaryHeaders
    
    Specified by:
    
    addChar in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addShort
```
Http2Headers addShort(AsciiString name,
                    short value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addShort in interface BinaryHeaders
    
    Specified by:
    
    addShort in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addInt
```
Http2Headers addInt(AsciiString name,
                  int value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addInt in interface BinaryHeaders
    
    Specified by:
    
    addInt in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addLong
```
Http2Headers addLong(AsciiString name,
                   long value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addLong in interface BinaryHeaders
    
    Specified by:
    
    addLong in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addFloat
```
Http2Headers addFloat(AsciiString name,
                    float value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addFloat in interface BinaryHeaders
    
    Specified by:
    
    addFloat in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addDouble
```
Http2Headers addDouble(AsciiString name,
                     double value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addDouble in interface BinaryHeaders
    
    Specified by:
    
    addDouble in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - addTimeMillis
```
Http2Headers addTimeMillis(AsciiString name,
                         long value)
```
    Description copied from interface: Headers
    
    Add the name to value.
    
    Specified by:
    
    addTimeMillis in interface BinaryHeaders
    
    Specified by:
    
    addTimeMillis in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - add
```
Http2Headers add(BinaryHeaders headers)
```
    Description copied from interface: BinaryHeaders
    
    See Headers.add(Headers)
    
    Specified by:
    
    add in interface BinaryHeaders
  - set
```
Http2Headers set(AsciiString name,
               AsciiString 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 BinaryHeaders
    
    Specified by:
    
    set in interface Headers<AsciiString>
    
    Parameters:
    name - The name of the header being set
    value - The value of the header being set
    
    Returns:
    this
  - set
```
Http2Headers set(AsciiString name,
               Iterable<? extends AsciiString> 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 BinaryHeaders
    
    Specified by:
    
    set in interface Headers<AsciiString>
    
    Parameters:
    name - the name of the headers being set
    values - the values of the headers being set
    
    Returns:
    this
  - set
```
Http2Headers set(AsciiString name,
               AsciiString... 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 BinaryHeaders
    
    Specified by:
    
    set in interface Headers<AsciiString>
    
    Parameters:
    name - the name of the headers being set
    values - the values of the headers being set
    
    Returns:
    this
  - setObject
```
Http2Headers setObject(AsciiString 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 BinaryHeaders
    
    Specified by:
    
    setObject in interface Headers<AsciiString>
    
    Parameters:
    name - The name of the header being set
    value - The value of the header being set
    
    Returns:
    this
  - setObject
```
Http2Headers setObject(AsciiString 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 BinaryHeaders
    
    Specified by:
    
    setObject in interface Headers<AsciiString>
    
    Parameters:
    name - the name of the headers being set
    values - the values of the headers being set
    
    Returns:
    this
  - setObject
```
Http2Headers setObject(AsciiString 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 BinaryHeaders
    
    Specified by:
    
    setObject in interface Headers<AsciiString>
    
    Parameters:
    name - the name of the headers being set
    values - the values of the headers being set
    
    Returns:
    this
  - setBoolean
```
Http2Headers setBoolean(AsciiString 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 BinaryHeaders
    
    Specified by:
    
    setBoolean in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setByte
```
Http2Headers setByte(AsciiString 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 BinaryHeaders
    
    Specified by:
    
    setByte in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setChar
```
Http2Headers setChar(AsciiString 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 BinaryHeaders
    
    Specified by:
    
    setChar in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setShort
```
Http2Headers setShort(AsciiString 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 BinaryHeaders
    
    Specified by:
    
    setShort in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setInt
```
Http2Headers setInt(AsciiString 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 BinaryHeaders
    
    Specified by:
    
    setInt in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setLong
```
Http2Headers setLong(AsciiString 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 BinaryHeaders
    
    Specified by:
    
    setLong in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setFloat
```
Http2Headers setFloat(AsciiString 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 BinaryHeaders
    
    Specified by:
    
    setFloat in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setDouble
```
Http2Headers setDouble(AsciiString 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 BinaryHeaders
    
    Specified by:
    
    setDouble in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setTimeMillis
```
Http2Headers setTimeMillis(AsciiString 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 BinaryHeaders
    
    Specified by:
    
    setTimeMillis in interface Headers<AsciiString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - set
```
Http2Headers set(BinaryHeaders headers)
```
    Description copied from interface: BinaryHeaders
    
    See Headers.set(Headers)
    
    Specified by:
    
    set in interface BinaryHeaders
  - setAll
```
Http2Headers setAll(BinaryHeaders headers)
```
    Description copied from interface: BinaryHeaders
    
    See Headers.setAll(Headers)
    
    Specified by:
    
    setAll in interface BinaryHeaders
  - clear
```
Http2Headers clear()
```
    Description copied from interface: Headers
    
    Removes all headers.
    
    Specified by:
    
    clear in interface BinaryHeaders
    
    Specified by:
    
    clear in interface Headers<AsciiString>
    
    Returns:
    this
  - method
```
Http2Headers method(AsciiString value)
```
    Sets the Http2Headers.PseudoHeaderName.METHOD header or null if there is no such header
  - scheme
```
Http2Headers scheme(AsciiString value)
```
    Sets the Http2Headers.PseudoHeaderName.SCHEME header if there is no such header
  - authority
```
Http2Headers authority(AsciiString value)
```
    Sets the Http2Headers.PseudoHeaderName.AUTHORITY header or null if there is no such header
  - path
```
Http2Headers path(AsciiString value)
```
    Sets the Http2Headers.PseudoHeaderName.PATH header or null if there is no such header
  - status
```
Http2Headers status(AsciiString value)
```
    Sets the Http2Headers.PseudoHeaderName.STATUS header or null if there is no such header
  - method
```
AsciiString method()
```
    Gets the Http2Headers.PseudoHeaderName.METHOD header or null if there is no such header
  - scheme
```
AsciiString scheme()
```
    Gets the Http2Headers.PseudoHeaderName.SCHEME header or null if there is no such header
  - authority
```
AsciiString authority()
```
    Gets the Http2Headers.PseudoHeaderName.AUTHORITY header or null if there is no such header
  - path
```
AsciiString path()
```
    Gets the Http2Headers.PseudoHeaderName.PATH header or null if there is no such header
  - status
```
AsciiString status()
```
    Gets the Http2Headers.PseudoHeaderName.STATUS header or null if there is no such header

Interface Http2Headers

Nested Class Summary

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

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

method

scheme

authority

path

status

method

scheme

authority

path

status