io.netty.handler.codec.http2

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 io.netty.handler.codec.DefaultHeaders

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

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

Http2Headers.PseudoHeaderName

Field Summary

Fields inherited from class io.netty.handler.codec.DefaultHeaders

head

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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 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 io.netty.handler.codec.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

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.handler.codec.http2.Http2Headers

iterator, valueIterator

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

add, add, add, add, addBoolean, addByte, addChar, addDouble, addFloat, addInt, addLong, addObject, addObject, addObject, addShort, addTimeMillis, 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, set, set, set, set, setAll, setBoolean, setByte, setChar, setDouble, setFloat, setInt, setLong, setObject, setObject, setObject, setShort, setTimeMillis, size

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DefaultHttp2Headers

public DefaultHttp2Headers()

Create a new instance.

Header names will be validated according to rfc7540.

DefaultHttp2Headers

public DefaultHttp2Headers(boolean validate)

Create a new instance.

Parameters:

validate - true to validate header names according to rfc7540. false to not validate header names.

DefaultHttp2Headers

public DefaultHttp2Headers(boolean validate,
                           int arraySizeHint)

Create a new instance.

Parameters:

validate - true to validate header names according to rfc7540. false to not validate header names.

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 validate,
                           boolean validateValues,
                           int arraySizeHint)

Create a new instance.

Parameters:

validate - true to validate header names according to rfc7540. false to not validate header names.

validateValues - true to validate header values according to rfc7230 and rfc5234. Otherwise, false (the default) 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 Detail

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>