Http2Headers (Netty API Reference (4.1.0.Beta6))

All Superinterfaces:

Headers<ByteString>, Iterable<Map.Entry<ByteString,ByteString>>

All Known Implementing Classes:

DefaultHttp2Headers, EmptyHttp2Headers
```
public interface Http2Headers
extends Headers<ByteString>
```
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
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(ByteString name, ByteString... values)` Adds new headers with the specified `name` and `values`.
`Http2Headers`	`add(ByteString name, ByteString value)` Adds a new header with the specified `name` and `value`.
`Http2Headers`	`add(ByteString name, Iterable<? extends ByteString> values)` Adds new headers with the specified `name` and `values`.
`Http2Headers`	`add(Headers<? extends ByteString> headers)` Adds all header names and values of `headers` to this object.
`Http2Headers`	`addBoolean(ByteString name, boolean value)` Adds a new header.
`Http2Headers`	`addByte(ByteString name, byte value)` Adds a new header.
`Http2Headers`	`addChar(ByteString name, char value)` Adds a new header.
`Http2Headers`	`addDouble(ByteString name, double value)` Adds a new header.
`Http2Headers`	`addFloat(ByteString name, float value)` Adds a new header.
`Http2Headers`	`addInt(ByteString name, int value)` Adds a new header.
`Http2Headers`	`addLong(ByteString name, long value)` Adds a new header.
`Http2Headers`	`addObject(ByteString name, Iterable<?> values)` Adds a new header with the specified name and values.
`Http2Headers`	`addObject(ByteString name, Object... values)` Adds a new header with the specified name and values.
`Http2Headers`	`addObject(ByteString name, Object value)` Adds a new header.
`Http2Headers`	`addShort(ByteString name, short value)` Adds a new header.
`Http2Headers`	`addTimeMillis(ByteString name, long value)` Adds a new header.
`ByteString`	`authority()` Gets the `Http2Headers.PseudoHeaderName.AUTHORITY` header or `null` if there is no such header
`Http2Headers`	`authority(ByteString value)` Sets the `Http2Headers.PseudoHeaderName.AUTHORITY` header or `null` if there is no such header
`Http2Headers`	`clear()` Removes all headers.
`Iterator<Map.Entry<ByteString,ByteString>>`	`iterator()` Returns an iterator over all HTTP/2 headers from this instance.
`ByteString`	`method()` Gets the `Http2Headers.PseudoHeaderName.METHOD` header or `null` if there is no such header
`Http2Headers`	`method(ByteString value)` Sets the `Http2Headers.PseudoHeaderName.METHOD` header or `null` if there is no such header
`ByteString`	`path()` Gets the `Http2Headers.PseudoHeaderName.PATH` header or `null` if there is no such header
`Http2Headers`	`path(ByteString value)` Sets the `Http2Headers.PseudoHeaderName.PATH` header or `null` if there is no such header
`ByteString`	`scheme()` Gets the `Http2Headers.PseudoHeaderName.SCHEME` header or `null` if there is no such header
`Http2Headers`	`scheme(ByteString value)` Sets the `Http2Headers.PseudoHeaderName.SCHEME` header if there is no such header
`Http2Headers`	`set(ByteString name, ByteString... values)` Sets a header with the specified name and values.
`Http2Headers`	`set(ByteString name, ByteString value)` Sets a header with the specified name and value.
`Http2Headers`	`set(ByteString name, Iterable<? extends ByteString> values)` Sets a new header with the specified name and values.
`Http2Headers`	`set(Headers<? extends ByteString> headers)` Clears the current header entries and copies all header entries of the specified `headers`.
`Http2Headers`	`setAll(Headers<? extends ByteString> headers)` Retains all current headers but calls `#set(T, T)` for each entry in `headers`.
`Http2Headers`	`setBoolean(ByteString name, boolean value)` Set the `name` to `value`.
`Http2Headers`	`setByte(ByteString name, byte value)` Set the `name` to `value`.
`Http2Headers`	`setChar(ByteString name, char value)` Set the `name` to `value`.
`Http2Headers`	`setDouble(ByteString name, double value)` Set the `name` to `value`.
`Http2Headers`	`setFloat(ByteString name, float value)` Set the `name` to `value`.
`Http2Headers`	`setInt(ByteString name, int value)` Set the `name` to `value`.
`Http2Headers`	`setLong(ByteString name, long value)` Set the `name` to `value`.
`Http2Headers`	`setObject(ByteString name, Iterable<?> values)` Sets a header with the specified name and values.
`Http2Headers`	`setObject(ByteString name, Object... values)` Sets a header with the specified name and values.
`Http2Headers`	`setObject(ByteString name, Object value)` Sets a new header.
`Http2Headers`	`setShort(ByteString name, short value)` Set the `name` to `value`.
`Http2Headers`	`setTimeMillis(ByteString name, long value)` Set the `name` to `value`.
`ByteString`	`status()` Gets the `Http2Headers.PseudoHeaderName.STATUS` header or `null` if there is no such header
`Http2Headers`	`status(ByteString value)` Sets the `Http2Headers.PseudoHeaderName.STATUS` header or `null` if there is no such header

Methods inherited from interface io.netty.handler.codec.Headers
contains, contains, containsBoolean, containsByte, containsChar, containsDouble, containsFloat, containsInt, containsLong, containsObject, containsShort, containsTimeMillis, 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, getIntAndRemove, getIntAndRemove, getLong, getLong, getLongAndRemove, getLongAndRemove, getShort, getShort, getShortAndRemove, getShortAndRemove, getTimeMillis, getTimeMillis, getTimeMillisAndRemove, getTimeMillisAndRemove, isEmpty, names, remove, size

- Method Detail
  - add
```
Http2Headers add(ByteString name,
               ByteString value)
```
    Description copied from interface: Headers
    
    Adds a new header with the specified name and value.
    
    Specified by:
    
    add in interface Headers<ByteString>
    
    Parameters:
    name - the name of the header
    value - the value of the header
    
    Returns:
    this
  - add
```
Http2Headers add(ByteString name,
               Iterable<? extends ByteString> values)
```
    Description copied from interface: Headers
    Adds new headers with the specified name and values. This method is semantically equivalent to
```
 for (T value : values) {
     headers.add(name, value);
 }
 
```
    Specified by:
    
    add in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    values - the values of the header
    
    Returns:
    this
  - add
```
Http2Headers add(ByteString name,
               ByteString... values)
```
    Description copied from interface: Headers
    Adds new headers with the specified name and values. This method is semantically equivalent to
```
 for (T value : values) {
     headers.add(name, value);
 }
 
```
    Specified by:
    
    add in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    values - the values of the header
    
    Returns:
    this
  - addObject
```
Http2Headers addObject(ByteString name,
                     Object value)
```
    Description copied from interface: Headers
    
    Adds a new header. Before the value is added, it's converted to type T.
    
    Specified by:
    
    addObject in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    value - the value of the header
    
    Returns:
    this
  - addObject
```
Http2Headers addObject(ByteString name,
                     Iterable<?> values)
```
    Description copied from interface: Headers
    Adds a new header with the specified name and values. This method is equivalent to
```
 for (Object v : values) {
     headers.addObject(name, v);
 }
 
```
    Specified by:
    
    addObject in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    values - the value of the header
    
    Returns:
    this
  - addObject
```
Http2Headers addObject(ByteString name,
                     Object... values)
```
    Description copied from interface: Headers
    Adds a new header with the specified name and values. This method is equivalent to
```
 for (Object v : values) {
     headers.addObject(name, v);
 }
 
```
    Specified by:
    
    addObject in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    values - the value of the header
    
    Returns:
    this
  - addBoolean
```
Http2Headers addBoolean(ByteString name,
                      boolean value)
```
    Description copied from interface: Headers
    
    Adds a new header.
    
    Specified by:
    
    addBoolean in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    value - the value of the header
    
    Returns:
    this
  - addByte
```
Http2Headers addByte(ByteString name,
                   byte value)
```
    Description copied from interface: Headers
    
    Adds a new header.
    
    Specified by:
    
    addByte in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    value - the value of the header
    
    Returns:
    this
  - addChar
```
Http2Headers addChar(ByteString name,
                   char value)
```
    Description copied from interface: Headers
    
    Adds a new header.
    
    Specified by:
    
    addChar in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    value - the value of the header
    
    Returns:
    this
  - addShort
```
Http2Headers addShort(ByteString name,
                    short value)
```
    Description copied from interface: Headers
    
    Adds a new header.
    
    Specified by:
    
    addShort in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    value - the value of the header
    
    Returns:
    this
  - addInt
```
Http2Headers addInt(ByteString name,
                  int value)
```
    Description copied from interface: Headers
    
    Adds a new header.
    
    Specified by:
    
    addInt in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    value - the value of the header
    
    Returns:
    this
  - addLong
```
Http2Headers addLong(ByteString name,
                   long value)
```
    Description copied from interface: Headers
    
    Adds a new header.
    
    Specified by:
    
    addLong in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    value - the value of the header
    
    Returns:
    this
  - addFloat
```
Http2Headers addFloat(ByteString name,
                    float value)
```
    Description copied from interface: Headers
    
    Adds a new header.
    
    Specified by:
    
    addFloat in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    value - the value of the header
    
    Returns:
    this
  - addDouble
```
Http2Headers addDouble(ByteString name,
                     double value)
```
    Description copied from interface: Headers
    
    Adds a new header.
    
    Specified by:
    
    addDouble in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    value - the value of the header
    
    Returns:
    this
  - addTimeMillis
```
Http2Headers addTimeMillis(ByteString name,
                         long value)
```
    Description copied from interface: Headers
    
    Adds a new header.
    
    Specified by:
    
    addTimeMillis in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    value - the value of the header
    
    Returns:
    this
  - add
```
Http2Headers add(Headers<? extends ByteString> headers)
```
    Description copied from interface: Headers
    
    Adds all header names and values of headers to this object.
    
    Specified by:
    
    add in interface Headers<ByteString>
    
    Returns:
    this
  - set
```
Http2Headers set(ByteString name,
               ByteString value)
```
    Description copied from interface: Headers
    
    Sets a header with the specified name and value. Any existing headers with the same name are overwritten.
    
    Specified by:
    
    set in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    value - the value of the header
    
    Returns:
    this
  - set
```
Http2Headers set(ByteString name,
               Iterable<? extends ByteString> values)
```
    Description copied from interface: Headers
    Sets a new header with the specified name and values. This method is equivalent to
```
 for (T v : values) {
     headers.addObject(name, v);
 }
 
```
    Specified by:
    
    set in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    values - the value of the header
    
    Returns:
    this
  - set
```
Http2Headers set(ByteString name,
               ByteString... values)
```
    Description copied from interface: Headers
    Sets a header with the specified name and values. Any existing headers with this name are removed. This method is equivalent to:
```
 headers.remove(name);
 for (T v : values) {
     headers.add(name, v);
 }
 
```
    Specified by:
    
    set in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    values - the value of the header
    
    Returns:
    this
  - setObject
```
Http2Headers setObject(ByteString name,
                     Object value)
```
    Description copied from interface: Headers
    
    Sets a new header. Any existing headers with this name are removed. Before the value is add, it's converted to type T.
    
    Specified by:
    
    setObject in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    value - the value of the header
    
    Returns:
    this
  - setObject
```
Http2Headers setObject(ByteString name,
                     Iterable<?> values)
```
    Description copied from interface: Headers
    Sets a header with the specified name and values. Any existing headers with this name are removed. This method is equivalent to:
```
 headers.remove(name);
 for (Object v : values) {
     headers.addObject(name, v);
 }
 
```
    Specified by:
    
    setObject in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    values - the values of the header
    
    Returns:
    this
  - setObject
```
Http2Headers setObject(ByteString name,
                     Object... values)
```
    Description copied from interface: Headers
    Sets a header with the specified name and values. Any existing headers with this name are removed. This method is equivalent to:
```
 headers.remove(name);
 for (Object v : values) {
     headers.addObject(name, v);
 }
 
```
    Specified by:
    
    setObject in interface Headers<ByteString>
    
    Parameters:
    name - the header name
    values - the values of the header
    
    Returns:
    this
  - setBoolean
```
Http2Headers setBoolean(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<ByteString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setByte
```
Http2Headers setByte(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<ByteString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setChar
```
Http2Headers setChar(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<ByteString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setShort
```
Http2Headers setShort(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<ByteString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setInt
```
Http2Headers setInt(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<ByteString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setLong
```
Http2Headers setLong(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<ByteString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setFloat
```
Http2Headers setFloat(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<ByteString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setDouble
```
Http2Headers setDouble(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<ByteString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - setTimeMillis
```
Http2Headers setTimeMillis(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<ByteString>
    
    Parameters:
    name - The name to modify
    value - The value
    
    Returns:
    this
  - set
```
Http2Headers set(Headers<? extends ByteString> headers)
```
    Description copied from interface: Headers
    
    Clears the current header entries and copies all header entries of the specified headers.
    
    Specified by:
    
    set in interface Headers<ByteString>
    
    Returns:
    this
  - setAll
```
Http2Headers setAll(Headers<? extends ByteString> headers)
```
    Description copied from interface: Headers
    
    Retains all current headers but calls #set(T, T) for each entry in headers.
    
    Specified by:
    
    setAll in interface Headers<ByteString>
    
    Parameters:
    headers - The headers used to #set(T, T) values in this instance
    
    Returns:
    this
  - clear
```
Http2Headers clear()
```
    Description copied from interface: Headers
    
    Removes all headers. After a call to this method Headers.size() equals 0.
    
    Specified by:
    
    clear in interface Headers<ByteString>
    
    Returns:
    this
  - iterator
```
Iterator<Map.Entry<ByteString,ByteString>> iterator()
```
    Returns an iterator over all HTTP/2 headers from this instance. The iteration order is as follows: 1. All non-pseudo headers (in no particular order). 2. Headers with multiple values will have their values appear in insertion order.
    
    Specified by:
    
    iterator in interface Headers<ByteString>
    
    Specified by:
    
    iterator in interface Iterable<Map.Entry<ByteString,ByteString>>
  - method
```
Http2Headers method(ByteString value)
```
    Sets the Http2Headers.PseudoHeaderName.METHOD header or null if there is no such header
  - scheme
```
Http2Headers scheme(ByteString value)
```
    Sets the Http2Headers.PseudoHeaderName.SCHEME header if there is no such header
  - authority
```
Http2Headers authority(ByteString value)
```
    Sets the Http2Headers.PseudoHeaderName.AUTHORITY header or null if there is no such header
  - path
```
Http2Headers path(ByteString value)
```
    Sets the Http2Headers.PseudoHeaderName.PATH header or null if there is no such header
  - status
```
Http2Headers status(ByteString value)
```
    Sets the Http2Headers.PseudoHeaderName.STATUS header or null if there is no such header
  - method
```
ByteString method()
```
    Gets the Http2Headers.PseudoHeaderName.METHOD header or null if there is no such header
  - scheme
```
ByteString scheme()
```
    Gets the Http2Headers.PseudoHeaderName.SCHEME header or null if there is no such header
  - authority
```
ByteString authority()
```
    Gets the Http2Headers.PseudoHeaderName.AUTHORITY header or null if there is no such header
  - path
```
ByteString path()
```
    Gets the Http2Headers.PseudoHeaderName.PATH header or null if there is no such header
  - status
```
ByteString status()
```
    Gets the Http2Headers.PseudoHeaderName.STATUS header or null if there is no such header

Interface Http2Headers

Nested Class Summary

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

iterator

method

scheme

authority

path

status

method

scheme

authority

path

status