Interface Http3Headers

All Superinterfaces:

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

All Known Implementing Classes:

DefaultHttp3Headers

public interface Http3Headers
extends Headers<CharSequence, CharSequence, Http3Headers>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Http3Headers.PseudoHeaderName	HTTP/2 (and HTTP/3) pseudo-headers names.

Method Summary

Modifier and Type	Method	Description
@Nullable 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
boolean	contains(CharSequence name, CharSequence value, boolean caseInsensitive)	Returns true if a header with the name and value exists, false otherwise.
Iterator<Map.Entry<CharSequence, CharSequence>>	iterator()	Returns an iterator over all HTTP/3 headers.
@Nullable 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
@Nullable 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
default @Nullable CharSequence	protocol()	Gets the Http3Headers.PseudoHeaderName.PROTOCOL header or null if there is no such header
default Http3Headers	protocol(CharSequence value)	Sets the Http3Headers.PseudoHeaderName.PROTOCOL header
@Nullable 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
@Nullable 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
Iterator<CharSequence>	valueIterator(CharSequence name)	Equivalent to Headers.getAll(Object) but no intermediate list is generated.

Methods inherited from interface Headers

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

Modifier and Type	Method	Description
Http3Headers	add(Headers<? extends CharSequence, ? extends CharSequence, ?> headers)	Adds all header names and values of headers to this object.
Http3Headers	add(CharSequence name, Iterable<? extends CharSequence> values)	Adds new headers with the specified name and values.
Http3Headers	add(CharSequence name, CharSequence value)	Adds a new header with the specified name and value.
Http3Headers	add(CharSequence name, CharSequence... values)	Adds new headers with the specified name and values.
Http3Headers	addBoolean(CharSequence name, boolean value)	Adds a new header.
Http3Headers	addByte(CharSequence name, byte value)	Adds a new header.
Http3Headers	addChar(CharSequence name, char value)	Adds a new header.
Http3Headers	addDouble(CharSequence name, double value)	Adds a new header.
Http3Headers	addFloat(CharSequence name, float value)	Adds a new header.
Http3Headers	addInt(CharSequence name, int value)	Adds a new header.
Http3Headers	addLong(CharSequence name, long value)	Adds a new header.
Http3Headers	addObject(CharSequence name, Iterable<?> values)	Adds a new header with the specified name and values.
Http3Headers	addObject(CharSequence name, Object value)	Adds a new header.
Http3Headers	addObject(CharSequence name, Object... values)	Adds a new header with the specified name and values.
Http3Headers	addShort(CharSequence name, short value)	Adds a new header.
Http3Headers	addTimeMillis(CharSequence name, long value)	Adds a new header.
Http3Headers	clear()	Removes all headers.
boolean	contains(CharSequence name)	Returns true if a header with the name exists, false otherwise.
boolean	contains(CharSequence name, CharSequence value)	Returns true if a header with the name and value exists, false otherwise.
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.
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.
boolean	isEmpty()	Returns true if Headers.size() equals 0.
Set<CharSequence>	names()	Returns a Set of all header names in this object.
boolean	remove(CharSequence name)	Removes all headers with the specified name.
Http3Headers	set(Headers<? extends CharSequence, ? extends CharSequence, ?> headers)	Clears the current header entries and copies all header entries of the specified headers.
Http3Headers	set(CharSequence name, Iterable<? extends CharSequence> values)	Sets a new header with the specified name and values.
Http3Headers	set(CharSequence name, CharSequence value)	Sets a header with the specified name and value.
Http3Headers	set(CharSequence name, CharSequence... values)	Sets a header with the specified name and values.
Http3Headers	setAll(Headers<? extends CharSequence, ? extends CharSequence, ?> headers)	Retains all current headers but calls Headers.set(K, V) for each entry in headers.
Http3Headers	setBoolean(CharSequence name, boolean value)	Set the name to value.
Http3Headers	setByte(CharSequence name, byte value)	Set the name to value.
Http3Headers	setChar(CharSequence name, char value)	Set the name to value.
Http3Headers	setDouble(CharSequence name, double value)	Set the name to value.
Http3Headers	setFloat(CharSequence name, float value)	Set the name to value.
Http3Headers	setInt(CharSequence name, int value)	Set the name to value.
Http3Headers	setLong(CharSequence name, long value)	Set the name to value.
Http3Headers	setObject(CharSequence name, Iterable<?> values)	Sets a header with the specified name and values.
Http3Headers	setObject(CharSequence name, Object value)	Sets a new header.
Http3Headers	setObject(CharSequence name, Object... values)	Sets a header with the specified name and values.
Http3Headers	setShort(CharSequence name, short value)	Set the name to value.
Http3Headers	setTimeMillis(CharSequence name, long value)	Set the name to value.
int	size()	Returns the number of headers in this object.

Methods inherited from interface Iterable

forEach, spliterator

Method Details

iterator

Iterator<Map.Entry<CharSequence, CharSequence>> iterator()

Returns an iterator over all HTTP/3 headers. The iteration order is as follows: 1. All pseudo headers (order not specified). 2. All non-pseudo headers (in insertion order).

Specified by:

iterator in interface Headers<CharSequence, CharSequence, Http3Headers>

Specified by:

iterator in interface Iterable<Map.Entry<CharSequence, CharSequence>>

valueIterator

Iterator<CharSequence> valueIterator(CharSequence name)

Equivalent to Headers.getAll(Object) but no intermediate list is generated.

Parameters:

name - the name of the header to retrieve

Returns:

an Iterator of header values corresponding to name.

method

Http3Headers method(CharSequence value)

Sets the Http3Headers.PseudoHeaderName.METHOD header

Parameters:

value - the value for the header.

Returns:

this instance itself.

scheme

Http3Headers scheme(CharSequence value)

Sets the Http3Headers.PseudoHeaderName.SCHEME header

Parameters:

value - the value for the header.

Returns:

this instance itself.

authority

Http3Headers authority(CharSequence value)

Sets the Http3Headers.PseudoHeaderName.AUTHORITY header

Parameters:

value - the value for the header.

Returns:

this instance itself.

path

Http3Headers path(CharSequence value)

Sets the Http3Headers.PseudoHeaderName.PATH header

Parameters:

value - the value for the header.

Returns:

this instance itself.

status

Http3Headers status(CharSequence value)

Sets the Http3Headers.PseudoHeaderName.STATUS header

Parameters:

value - the value for the header.

Returns:

this instance itself.

protocol

default Http3Headers protocol(CharSequence value)

Sets the Http3Headers.PseudoHeaderName.PROTOCOL header

This pseudo-header is used for Extended CONNECT requests as defined in RFC 9220. Common values include "webtransport" and "websocket".

Parameters:

value - the value for the header.

Returns:

this instance itself.

See Also:

• RFC 9220: Bootstrapping WebSockets with HTTP/3

method

@Nullable
@Nullable CharSequence method()

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

Returns:

the value of the header.

scheme

@Nullable
@Nullable CharSequence scheme()

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

Returns:

the value of the header.

authority

@Nullable
@Nullable CharSequence authority()

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

Returns:

the value of the header.

path

@Nullable
@Nullable CharSequence path()

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

Returns:

the value of the header.

status

@Nullable
@Nullable CharSequence status()

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

Returns:

the value of the header.

protocol

@Nullable
default @Nullable CharSequence protocol()

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

This pseudo-header is used for Extended CONNECT requests as defined in RFC 9220.

Returns:

the value of the header.

See Also:

• RFC 9220: Bootstrapping WebSockets with HTTP/3

contains

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

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.

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.