Package io.netty.handler.codec.http3

Class DefaultHttp3Headers

java.lang.Object

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

io.netty.handler.codec.http3.DefaultHttp3Headers

All Implemented Interfaces:

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

public final class DefaultHttp3Headers
extends DefaultHeaders<CharSequence,CharSequence,Http3Headers>
implements Http3Headers

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.http3.Http3Headers

Http3Headers.PseudoHeaderName

Field Summary

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

head

Constructor Summary

Constructors

Constructor	Description
DefaultHttp3Headers()	Create a new instance.
DefaultHttp3Headers(boolean validate)	Create a new instance.
DefaultHttp3Headers(boolean validate, int arraySizeHint)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
CharSequence	authority()	Gets the Http3Headers.PseudoHeaderName.AUTHORITY header or null if there is no such header
Http3Headers	authority(CharSequence value)	Sets the Http3Headers.PseudoHeaderName.AUTHORITY header
Http3Headers	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 Http3Headers.PseudoHeaderName.METHOD header or null if there is no such header
Http3Headers	method(CharSequence value)	Sets the Http3Headers.PseudoHeaderName.METHOD header
protected DefaultHeaders.HeaderEntry<CharSequence,CharSequence>	newHeaderEntry(int h, CharSequence name, CharSequence value, DefaultHeaders.HeaderEntry<CharSequence,CharSequence> next)
CharSequence	path()	Gets the Http3Headers.PseudoHeaderName.PATH header or null if there is no such header
Http3Headers	path(CharSequence value)	Sets the Http3Headers.PseudoHeaderName.PATH header
CharSequence	scheme()	Gets the Http3Headers.PseudoHeaderName.SCHEME header or null if there is no such header
Http3Headers	scheme(CharSequence value)	Sets the Http3Headers.PseudoHeaderName.SCHEME header
CharSequence	status()	Gets the Http3Headers.PseudoHeaderName.STATUS header or null if there is no such header
Http3Headers	status(CharSequence value)	Sets the Http3Headers.PseudoHeaderName.STATUS header

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, containsAny, 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, validateName, validateValue, 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.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 io.netty.handler.codec.http3.Http3Headers

iterator, protocol, protocol, valueIterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

DefaultHttp3Headers

public DefaultHttp3Headers()

Create a new instance.

Header names will be validated according to rfc7540.

DefaultHttp3Headers

public DefaultHttp3Headers(boolean validate)

Create a new instance.

Parameters:

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

DefaultHttp3Headers

public DefaultHttp3Headers(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.

Method Details

clear

public Http3Headers 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,Http3Headers>

Overrides:

clear in class DefaultHeaders<CharSequence,CharSequence,Http3Headers>

Returns:

this

equals

public boolean equals(Object o)

Overrides:

equals in class DefaultHeaders<CharSequence,CharSequence,Http3Headers>

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultHeaders<CharSequence,CharSequence,Http3Headers>

method

public Http3Headers method(CharSequence value)

Description copied from interface: Http3Headers

Sets the Http3Headers.PseudoHeaderName.METHOD header

Specified by:

method in interface Http3Headers

Parameters:

value - the value for the header.

Returns:

this instance itself.

scheme

public Http3Headers scheme(CharSequence value)

Description copied from interface: Http3Headers

Sets the Http3Headers.PseudoHeaderName.SCHEME header

Specified by:

scheme in interface Http3Headers

Parameters:

value - the value for the header.

Returns:

this instance itself.

authority

public Http3Headers authority(CharSequence value)

Description copied from interface: Http3Headers

Sets the Http3Headers.PseudoHeaderName.AUTHORITY header

Specified by:

authority in interface Http3Headers

Parameters:

value - the value for the header.

Returns:

this instance itself.

path

public Http3Headers path(CharSequence value)

Description copied from interface: Http3Headers

Sets the Http3Headers.PseudoHeaderName.PATH header

Specified by:

path in interface Http3Headers

Parameters:

value - the value for the header.

Returns:

this instance itself.

status

public Http3Headers status(CharSequence value)

Description copied from interface: Http3Headers

Sets the Http3Headers.PseudoHeaderName.STATUS header

Specified by:

status in interface Http3Headers

Parameters:

value - the value for the header.

Returns:

this instance itself.

method

public CharSequence method()

Description copied from interface: Http3Headers

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

Specified by:

method in interface Http3Headers

Returns:

the value of the header.

scheme

public CharSequence scheme()

Description copied from interface: Http3Headers

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

Specified by:

scheme in interface Http3Headers

Returns:

the value of the header.

authority

public CharSequence authority()

Description copied from interface: Http3Headers

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

Specified by:

authority in interface Http3Headers

Returns:

the value of the header.

path

public CharSequence path()

Description copied from interface: Http3Headers

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

Specified by:

path in interface Http3Headers

Returns:

the value of the header.

status

public CharSequence status()

Description copied from interface: Http3Headers

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

Specified by:

status in interface Http3Headers

Returns:

the value of the header.

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,Http3Headers>

Overrides:

contains in class DefaultHeaders<CharSequence,CharSequence,Http3Headers>

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: Http3Headers

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 Http3Headers

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.

Returns:

true if its contained, false otherwise.

newHeaderEntry

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

Overrides:

newHeaderEntry in class DefaultHeaders<CharSequence,CharSequence,Http3Headers>