Class DefaultHttp2Headers

java.lang.Object

io.netty.handler.codec.DefaultHeaders<CharSequence, CharSequence, Http2Headers>

io.netty.handler.codec.http2.DefaultHttp2Headers

All Implemented Interfaces:

Headers<CharSequence, CharSequence, Http2Headers>, Http2Headers, Iterable<Map.Entry<CharSequence, CharSequence>>

public class DefaultHttp2Headers
extends DefaultHeaders<CharSequence, CharSequence, Http2Headers>
implements Http2Headers

Nested Class Summary

Nested classes/interfaces inherited from class DefaultHeaders

DefaultHeaders.HeaderEntry<K,V>, DefaultHeaders.NameValidator<K>, DefaultHeaders.ValueValidator<V>

Modifier and Type	Class	Description
protected static class	DefaultHeaders.HeaderEntry<K,V>
static interface	DefaultHeaders.NameValidator<K>
static interface	DefaultHeaders.ValueValidator<V>

Nested classes/interfaces inherited from interface Http2Headers

Http2Headers.PseudoHeaderName

Modifier and Type	Interface	Description
static enum	Http2Headers.PseudoHeaderName	HTTP/2 pseudo-headers names.

Field Summary

Fields inherited from class DefaultHeaders

head

Modifier and Type	Field	Description
protected final DefaultHeaders.HeaderEntry<CharSequence, CharSequence>	head

Constructor Summary

Constructors

Constructor	Description
DefaultHttp2Headers()	Create a new instance.
DefaultHttp2Headers(boolean validate)	Create a new instance.
DefaultHttp2Headers(boolean validateNames, boolean validateValues, int arraySizeHint)	Create a new instance.
DefaultHttp2Headers(boolean validate, int arraySizeHint)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
CharSequence	authority()	Gets the Http2Headers.PseudoHeaderName.AUTHORITY header or null if there is no such header
Http2Headers	authority(CharSequence value)	Sets the Http2Headers.PseudoHeaderName.AUTHORITY header
Http2Headers	clear()	Removes all headers.
boolean	contains(CharSequence name, CharSequence value)	Returns true if a header with the name and value exists, false otherwise.
boolean	contains(CharSequence name, CharSequence value, boolean caseInsensitive)	Returns true if a header with the name and value exists, false otherwise.
boolean	equals(Object o)
int	hashCode()
CharSequence	method()	Gets the Http2Headers.PseudoHeaderName.METHOD header or null if there is no such header
Http2Headers	method(CharSequence value)	Sets the Http2Headers.PseudoHeaderName.METHOD header
protected final DefaultHeaders.HeaderEntry<CharSequence, CharSequence>	newHeaderEntry(int h, CharSequence name, CharSequence value, DefaultHeaders.HeaderEntry<CharSequence, CharSequence> next)
CharSequence	path()	Gets the Http2Headers.PseudoHeaderName.PATH header or null if there is no such header
Http2Headers	path(CharSequence value)	Sets the Http2Headers.PseudoHeaderName.PATH header
CharSequence	scheme()	Gets the Http2Headers.PseudoHeaderName.SCHEME header or null if there is no such header
Http2Headers	scheme(CharSequence value)	Sets the Http2Headers.PseudoHeaderName.SCHEME header
CharSequence	status()	Gets the Http2Headers.PseudoHeaderName.STATUS header or null if there is no such header
Http2Headers	status(CharSequence value)	Sets the Http2Headers.PseudoHeaderName.STATUS header
protected void	validateName(DefaultHeaders.NameValidator<CharSequence> validator, boolean forAdd, CharSequence name)	Call out to the given DefaultHeaders.NameValidator to validate the given name.
protected void	validateValue(DefaultHeaders.ValueValidator<CharSequence> validator, CharSequence name, CharSequence value)

Methods inherited from class DefaultHeaders

add, add, add, add, addBoolean, addByte, addChar, addDouble, addFloat, addImpl, addInt, addLong, addObject, addObject, addObject, addShort, addTimeMillis, contains, contains, containsBoolean, containsByte, containsChar, containsDouble, containsFloat, containsInt, containsLong, containsObject, containsShort, containsTimeMillis, copy, equals, 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, hashCode, isEmpty, iterator, names, nameValidator, remove, set, set, set, set, setAll, setBoolean, setByte, setChar, setDouble, setFloat, setInt, setLong, setObject, setObject, setObject, setShort, setTimeMillis, size, toString, valueConverter, valueIterator, valueValidator

Modifier and Type	Method	Description
Http2Headers	add(Headers<? extends CharSequence, ? extends CharSequence, ?> headers)	Adds all header names and values of headers to this object.
Http2Headers	add(CharSequence name, Iterable<? extends CharSequence> values)	Adds new headers with the specified name and values.
Http2Headers	add(CharSequence name, CharSequence value)	Adds a new header with the specified name and value.
Http2Headers	add(CharSequence name, CharSequence... values)	Adds new headers with the specified name and values.
Http2Headers	addBoolean(CharSequence name, boolean value)	Adds a new header.
Http2Headers	addByte(CharSequence name, byte value)	Adds a new header.
Http2Headers	addChar(CharSequence name, char value)	Adds a new header.
Http2Headers	addDouble(CharSequence name, double value)	Adds a new header.
Http2Headers	addFloat(CharSequence name, float value)	Adds a new header.
protected void	addImpl(Headers<? extends CharSequence, ? extends CharSequence, ?> headers)
Http2Headers	addInt(CharSequence name, int value)	Adds a new header.
Http2Headers	addLong(CharSequence name, long value)	Adds a new header.
Http2Headers	addObject(CharSequence name, Iterable<?> values)	Adds a new header with the specified name and values.
Http2Headers	addObject(CharSequence name, Object value)	Adds a new header.
Http2Headers	addObject(CharSequence name, Object... values)	Adds a new header with the specified name and values.
Http2Headers	addShort(CharSequence name, short value)	Adds a new header.
Http2Headers	addTimeMillis(CharSequence name, long value)	Adds a new header.
boolean	contains(CharSequence name)	Returns true if a header with the name exists, false otherwise.
final boolean	contains(CharSequence name, CharSequence value, HashingStrategy<? super CharSequence> valueHashingStrategy)
boolean	containsBoolean(CharSequence name, boolean value)	Returns true if a header with the name and value exists.
boolean	containsByte(CharSequence name, byte value)	Returns true if a header with the name and value exists.
boolean	containsChar(CharSequence name, char value)	Returns true if a header with the name and value exists.
boolean	containsDouble(CharSequence name, double value)	Returns true if a header with the name and value exists.
boolean	containsFloat(CharSequence name, float value)	Returns true if a header with the name and value exists.
boolean	containsInt(CharSequence name, int value)	Returns true if a header with the name and value exists.
boolean	containsLong(CharSequence name, long value)	Returns true if a header with the name and value exists.
boolean	containsObject(CharSequence name, Object value)	Returns true if a header with the name and value exists.
boolean	containsShort(CharSequence name, short value)	Returns true if a header with the name and value exists.
boolean	containsTimeMillis(CharSequence name, long value)	Returns true if a header with the name and value exists.
DefaultHeaders<CharSequence, CharSequence, Http2Headers>	copy()	Returns a deep copy of this instance.
final boolean	equals(Headers<CharSequence, CharSequence, ?> h2, HashingStrategy<CharSequence> valueHashingStrategy)	Test this object for equality against h2.
CharSequence	get(CharSequence name)	Returns the value of a header with the specified name.
CharSequence	get(CharSequence name, CharSequence defaultValue)	Returns the value of a header with the specified name.
List<CharSequence>	getAll(CharSequence name)	Returns all values for the header with the specified name.
List<CharSequence>	getAllAndRemove(CharSequence name)	Returns all values for the header with the specified name and removes them from this object.
CharSequence	getAndRemove(CharSequence name)	Returns the value of a header with the specified name and removes it from this object.
CharSequence	getAndRemove(CharSequence name, CharSequence defaultValue)	Returns the value of a header with the specified name and removes it from this object.
Boolean	getBoolean(CharSequence name)	Returns the boolean value of a header with the specified name.
boolean	getBoolean(CharSequence name, boolean defaultValue)	Returns the boolean value of a header with the specified name.
Boolean	getBooleanAndRemove(CharSequence name)	Returns the boolean value of a header with the specified name and removes the header from this object.
boolean	getBooleanAndRemove(CharSequence name, boolean defaultValue)	Returns the boolean value of a header with the specified name and removes the header from this object.
Byte	getByte(CharSequence name)	Returns the byte value of a header with the specified name.
byte	getByte(CharSequence name, byte defaultValue)	Returns the byte value of a header with the specified name.
Byte	getByteAndRemove(CharSequence name)	Returns the byte value of a header with the specified name and removes the header from this object.
byte	getByteAndRemove(CharSequence name, byte defaultValue)	Returns the byte value of a header with the specified name and removes the header from this object.
Character	getChar(CharSequence name)	Returns the char value of a header with the specified name.
char	getChar(CharSequence name, char defaultValue)	Returns the char value of a header with the specified name.
Character	getCharAndRemove(CharSequence name)	Returns the char value of a header with the specified name and removes the header from this object.
char	getCharAndRemove(CharSequence name, char defaultValue)	Returns the char value of a header with the specified name and removes the header from this object.
Double	getDouble(CharSequence name)	Returns the double value of a header with the specified name.
double	getDouble(CharSequence name, double defaultValue)	Returns the double value of a header with the specified name.
Double	getDoubleAndRemove(CharSequence name)	Returns the double value of a header with the specified name and removes the header from this object.
double	getDoubleAndRemove(CharSequence name, double defaultValue)	Returns the double value of a header with the specified name and removes the header from this object.
Float	getFloat(CharSequence name)	Returns the float value of a header with the specified name.
float	getFloat(CharSequence name, float defaultValue)	Returns the float value of a header with the specified name.
Float	getFloatAndRemove(CharSequence name)	Returns the float value of a header with the specified name and removes the header from this object.
float	getFloatAndRemove(CharSequence name, float defaultValue)	Returns the float value of a header with the specified name and removes the header from this object.
Integer	getInt(CharSequence name)	Returns the int value of a header with the specified name.
int	getInt(CharSequence name, int defaultValue)	Returns the int value of a header with the specified name.
Integer	getIntAndRemove(CharSequence name)	Returns the int value of a header with the specified name and removes the header from this object.
int	getIntAndRemove(CharSequence name, int defaultValue)	Returns the int value of a header with the specified name and removes the header from this object.
Long	getLong(CharSequence name)	Returns the long value of a header with the specified name.
long	getLong(CharSequence name, long defaultValue)	Returns the long value of a header with the specified name.
Long	getLongAndRemove(CharSequence name)	Returns the long value of a header with the specified name and removes the header from this object.
long	getLongAndRemove(CharSequence name, long defaultValue)	Returns the long value of a header with the specified name and removes the header from this object.
Short	getShort(CharSequence name)	Returns the short value of a header with the specified name.
short	getShort(CharSequence name, short defaultValue)	Returns the short value of a header with the specified name.
Short	getShortAndRemove(CharSequence name)	Returns the short value of a header with the specified name and removes the header from this object.
short	getShortAndRemove(CharSequence name, short defaultValue)	Returns the short value of a header with the specified name and removes the header from this object.
Long	getTimeMillis(CharSequence name)	Returns the value of a header with the specified name in milliseconds.
long	getTimeMillis(CharSequence name, long defaultValue)	Returns the value of a header with the specified name in milliseconds.
Long	getTimeMillisAndRemove(CharSequence name)	Returns the value of a header with the specified name in milliseconds and removes the header from this object.
long	getTimeMillisAndRemove(CharSequence name, long defaultValue)	Returns the value of a header with the specified name in milliseconds and removes the header from this object.
final int	hashCode(HashingStrategy<CharSequence> valueHashingStrategy)	Generate a hash code for this object given a HashingStrategy to generate hash codes for individual values.
boolean	isEmpty()	Returns true if Headers.size() equals 0.
Iterator<Map.Entry<CharSequence, CharSequence>>	iterator()
Set<CharSequence>	names()	Returns a Set of all header names in this object.
protected DefaultHeaders.NameValidator<CharSequence>	nameValidator()
boolean	remove(CharSequence name)	Removes all headers with the specified name.
Http2Headers	set(Headers<? extends CharSequence, ? extends CharSequence, ?> headers)	Clears the current header entries and copies all header entries of the specified headers.
Http2Headers	set(CharSequence name, Iterable<? extends CharSequence> values)	Sets a new header with the specified name and values.
Http2Headers	set(CharSequence name, CharSequence value)	Sets a header with the specified name and value.
Http2Headers	set(CharSequence name, CharSequence... values)	Sets a header with the specified name and values.
Http2Headers	setAll(Headers<? extends CharSequence, ? extends CharSequence, ?> headers)	Retains all current headers but calls Headers.set(K, V) for each entry in headers.
Http2Headers	setBoolean(CharSequence name, boolean value)	Set the name to value.
Http2Headers	setByte(CharSequence name, byte value)	Set the name to value.
Http2Headers	setChar(CharSequence name, char value)	Set the name to value.
Http2Headers	setDouble(CharSequence name, double value)	Set the name to value.
Http2Headers	setFloat(CharSequence name, float value)	Set the name to value.
Http2Headers	setInt(CharSequence name, int value)	Set the name to value.
Http2Headers	setLong(CharSequence name, long value)	Set the name to value.
Http2Headers	setObject(CharSequence name, Iterable<?> values)	Sets a header with the specified name and values.
Http2Headers	setObject(CharSequence name, Object value)	Sets a new header.
Http2Headers	setObject(CharSequence name, Object... values)	Sets a header with the specified name and values.
Http2Headers	setShort(CharSequence name, short value)	Set the name to value.
Http2Headers	setTimeMillis(CharSequence name, long value)	Set the name to value.
int	size()	Returns the number of headers in this object.
String	toString()
protected ValueConverter<CharSequence>	valueConverter()
Iterator<CharSequence>	valueIterator(CharSequence name)	Equivalent to DefaultHeaders.getAll(Object) but no intermediate list is generated.
protected DefaultHeaders.ValueValidator<CharSequence>	valueValidator()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Http2Headers

iterator, valueIterator

Modifier and Type	Method	Description
Iterator<Map.Entry<CharSequence, CharSequence>>	iterator()	Returns an iterator over all HTTP/2 headers.
Iterator<CharSequence>	valueIterator(CharSequence name)	Equivalent to Headers.getAll(Object) but no intermediate list is generated.

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

DefaultHttp2Headers

public DefaultHttp2Headers()

Create a new instance.

Header names and values will be validated according to RFC 9113.

DefaultHttp2Headers

public DefaultHttp2Headers(boolean validate)

Create a new instance.

Parameters:

validate - true to validate header names and values according to RFC 9113. false to not validate header names or values.

DefaultHttp2Headers

public DefaultHttp2Headers(boolean validate,
 int arraySizeHint)

Create a new instance.

Parameters:

validate - true to validate header names and values according to RFC 9113. false to not validate header names or values.

arraySizeHint - A hint as to how large the hash data structure should be. The next positive power of two will be used. An upper bound may be enforced.

See Also:

• DefaultHttp2Headers(boolean, boolean, int)

DefaultHttp2Headers

public DefaultHttp2Headers(boolean validateNames,
 boolean validateValues,
 int arraySizeHint)

Create a new instance.

Parameters:

validateNames - true to validate header names according to RFC 9113. false to not validate header names.

validateValues - true to validate header values according to RFC 9113. Otherwise, false to not validate values.

arraySizeHint - A hint as to how large the hash data structure should be. The next positive power of two will be used. An upper bound may be enforced.

Method Details

validateName

protected void validateName(DefaultHeaders.NameValidator<CharSequence> validator,
 boolean forAdd,
 CharSequence name)

Description copied from class: DefaultHeaders

Call out to the given DefaultHeaders.NameValidator to validate the given name.

Overrides:

validateName in class DefaultHeaders<CharSequence, CharSequence, Http2Headers>

Parameters:

validator - the validator to use

forAdd - true if this validation is for adding to the headers, or false if this is for setting (overwriting) the given header.

name - the name to validate.

validateValue

protected void validateValue(DefaultHeaders.ValueValidator<CharSequence> validator,
 CharSequence name,
 CharSequence value)

Overrides:

validateValue in class DefaultHeaders<CharSequence, CharSequence, Http2Headers>

clear

public 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<CharSequence, CharSequence, Http2Headers>

Overrides:

clear in class DefaultHeaders<CharSequence, CharSequence, Http2Headers>

Returns:

this

equals

public boolean equals(Object o)

Overrides:

equals in class DefaultHeaders<CharSequence, CharSequence, Http2Headers>

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultHeaders<CharSequence, CharSequence, Http2Headers>

method

public Http2Headers method(CharSequence value)

Description copied from interface: Http2Headers

Sets the Http2Headers.PseudoHeaderName.METHOD header

Specified by:

method in interface Http2Headers

scheme

public Http2Headers scheme(CharSequence value)

Description copied from interface: Http2Headers

Sets the Http2Headers.PseudoHeaderName.SCHEME header

Specified by:

scheme in interface Http2Headers

authority

public Http2Headers authority(CharSequence value)

Description copied from interface: Http2Headers

Sets the Http2Headers.PseudoHeaderName.AUTHORITY header

Specified by:

authority in interface Http2Headers

path

public Http2Headers path(CharSequence value)

Description copied from interface: Http2Headers

Sets the Http2Headers.PseudoHeaderName.PATH header

Specified by:

path in interface Http2Headers

status

public Http2Headers status(CharSequence value)

Description copied from interface: Http2Headers

Sets the Http2Headers.PseudoHeaderName.STATUS header

Specified by:

status in interface Http2Headers

method

public CharSequence method()

Description copied from interface: Http2Headers

Gets the Http2Headers.PseudoHeaderName.METHOD header or null if there is no such header

Specified by:

method in interface Http2Headers

scheme

public CharSequence scheme()

Description copied from interface: Http2Headers

Gets the Http2Headers.PseudoHeaderName.SCHEME header or null if there is no such header

Specified by:

scheme in interface Http2Headers

authority

public CharSequence authority()

Description copied from interface: Http2Headers

Gets the Http2Headers.PseudoHeaderName.AUTHORITY header or null if there is no such header

Specified by:

authority in interface Http2Headers

path

public CharSequence path()

Description copied from interface: Http2Headers

Gets the Http2Headers.PseudoHeaderName.PATH header or null if there is no such header

Specified by:

path in interface Http2Headers

status

public CharSequence status()

Description copied from interface: Http2Headers

Gets the Http2Headers.PseudoHeaderName.STATUS header or null if there is no such header

Specified by:

status in interface Http2Headers

contains

public boolean contains(CharSequence name,
 CharSequence value)

Description copied from interface: Headers

Returns true if a header with the name and value exists, false otherwise.

The Object.equals(Object) method is used to test for equality of value.

Specified by:

contains in interface Headers<CharSequence, CharSequence, Http2Headers>

Overrides:

contains in class DefaultHeaders<CharSequence, CharSequence, Http2Headers>

Parameters:

name - the header name

value - the header value of the header to find

contains

public boolean contains(CharSequence name,
 CharSequence value,
 boolean caseInsensitive)

Description copied from interface: Http2Headers

Returns true if a header with the name and value exists, false otherwise.

If caseInsensitive is true then a case insensitive compare is done on the value.

Specified by:

contains in interface Http2Headers

Parameters:

name - the name of the header to find

value - the value of the header to find

caseInsensitive - true then a case insensitive compare is run to compare values. otherwise a case sensitive compare is run to compare values.

newHeaderEntry

protected final DefaultHeaders.HeaderEntry<CharSequence, CharSequence> newHeaderEntry(int h,
 CharSequence name,
 CharSequence value,
 DefaultHeaders.HeaderEntry<CharSequence, CharSequence> next)

Overrides:

newHeaderEntry in class DefaultHeaders<CharSequence, CharSequence, Http2Headers>