io.netty.handler.codec

Interface BinaryHeaders

All Superinterfaces:

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

All Known Subinterfaces:

Http2Headers

All Known Implementing Classes:

DefaultBinaryHeaders, DefaultHttp2Headers, EmptyBinaryHeaders, EmptyHttp2Headers

public interface BinaryHeaders
extends Headers<AsciiString>

A typical AsciiString multimap used by protocols that use binary headers (such as HTTP/2) for the representation of arbitrary key-value data. AsciiString 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 A visitor that helps reduce GC pressure while iterating over a collection of Headers.
static interface	BinaryHeaders.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.Headers

Headers.ValueConverter<T>

Method Summary

Methods

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

Parameters:

name - the name of the header being added

value - the value of the header being added

Returns:

this

add

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - the name of the headepublic abstract rs being set

values - the values of the headers being set

Returns:

this

add

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - the name of the headepublic abstract rs being set

values - the values of the headers being set

Returns:

this

addObject

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - the name of the header being added

value - the value of the header being added

Returns:

this

addObject

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - the name of the headepublic abstract rs being set

values - the values of the headers being set

Returns:

this

addObject

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - the name of the headepublic abstract rs being set

values - the values of the headers being set

Returns:

this

addBoolean

BinaryHeaders addBoolean(AsciiString name,
                       boolean value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addBoolean in interface Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

addByte

BinaryHeaders addByte(AsciiString name,
                    byte value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addByte in interface Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

addChar

BinaryHeaders addChar(AsciiString name,
                    char value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addChar in interface Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

addShort

BinaryHeaders addShort(AsciiString name,
                     short value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addShort in interface Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

addInt

BinaryHeaders addInt(AsciiString name,
                   int value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addInt in interface Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

addLong

BinaryHeaders addLong(AsciiString name,
                    long value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addLong in interface Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

addFloat

BinaryHeaders addFloat(AsciiString name,
                     float value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addFloat in interface Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

addDouble

BinaryHeaders addDouble(AsciiString name,
                      double value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addDouble in interface Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

addTimeMillis

BinaryHeaders addTimeMillis(AsciiString name,
                          long value)

Description copied from interface: Headers

Add the name to value.

Specified by:

addTimeMillis in interface Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

add

BinaryHeaders add(BinaryHeaders headers)

See Headers.add(Headers)

set

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - The name of the header being set

value - The value of the header being set

Returns:

this

set

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - the name of the headers being set

values - the values of the headers being set

Returns:

this

set

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - the name of the headers being set

values - the values of the headers being set

Returns:

this

setObject

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - The name of the header being set

value - The value of the header being set

Returns:

this

setObject

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - the name of the headers being set

values - the values of the headers being set

Returns:

this

setObject

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - the name of the headers being set

values - the values of the headers being set

Returns:

this

setBoolean

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

setByte

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

setChar

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

setShort

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

setInt

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

setLong

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

setFloat

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

setDouble

BinaryHeaders 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 Headers<AsciiString>

Parameters:

name - The name to modify

value - The value

Returns:

this

setTimeMillis

BinaryHeaders 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 Headers<AsciiString>

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<AsciiString>

Returns:

this