Nested and Inner Type Summary

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

Method Summary

Modifier and Type	Method and Description
public Http2Headers	authority(CharSequence value) Sets the `PseudoHeaderName#AUTHORITY` header
public CharSequence	authority() Gets the `PseudoHeaderName#AUTHORITY` header or `null` if there is no such header
public boolean	contains(CharSequence the name of the header to find name, CharSequence the value of the header to find value, boolean `true` then a case insensitive compare is run to compare values. otherwise a case sensitive compare is run to compare values. caseInsensitive) Returns `true` if a header with the `name` and `value` exists, `false` otherwise.
public Iterator<Map.Entry<CharSequence, CharSequence>>	iterator() Redeclares io.netty.handler.codec.Headers.iterator. Returns an iterator over all HTTP/2 headers.
public Http2Headers	method(CharSequence value) Sets the `PseudoHeaderName#METHOD` header
public CharSequence	method() Gets the `PseudoHeaderName#METHOD` header or `null` if there is no such header
public Http2Headers	path(CharSequence value) Sets the `PseudoHeaderName#PATH` header
public CharSequence	path() Gets the `PseudoHeaderName#PATH` header or `null` if there is no such header
public Http2Headers	scheme(CharSequence value) Sets the `PseudoHeaderName#SCHEME` header
public CharSequence	scheme() Gets the `PseudoHeaderName#SCHEME` header or `null` if there is no such header
public Http2Headers	status(CharSequence value) Sets the `PseudoHeaderName#STATUS` header
public CharSequence	status() Gets the `PseudoHeaderName#STATUS` header or `null` if there is no such header
public Iterator<CharSequence>	Returns: an `Iterator` of header values corresponding to `name`. valueIterator(CharSequence the name of the header to retrieve name) Equivalent to `getAll(Object)` but no intermediate list is generated.

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

Method Detail

authority	back to summary
public Http2Headers authority(CharSequence value) Sets the `PseudoHeaderName#AUTHORITY` header

authority	back to summary
public CharSequence authority() Gets the `PseudoHeaderName#AUTHORITY` header or `null` if there is no such header

contains back to summary

contains	back to summary
public 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:CharSequence the name of the header to find value:CharSequence the value of the header to find caseInsensitive:boolean `true` then a case insensitive compare is run to compare values. otherwise a case sensitive compare is run to compare values.

public 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:CharSequence: the name of the header to find
value:CharSequence: the value of the header to find
caseInsensitive:boolean: true then a case insensitive compare is run to compare values. otherwise a case sensitive compare is run to compare values.

iterator	back to summary
public Iterator<Map.Entry<CharSequence, CharSequence>> iterator() Redeclares io.netty.handler.codec.Headers.iterator. Returns an iterator over all HTTP/2 headers. The iteration order is as follows: 1. All pseudo headers (order not specified). 2. All non-pseudo headers (in insertion order). Returns:Iterator<Map.Entry<CharSequence, CharSequence>> Doc from java.lang.Iterable.iterator. an Iterator. Annotations @Override

iterator

back to summary

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

Redeclares io.netty.handler.codec.Headers.iterator.

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

Returns:Iterator<Map.Entry<CharSequence, CharSequence>>

Doc from java.lang.Iterable.iterator.

an Iterator.

Annotations

@Override

method	back to summary
public Http2Headers method(CharSequence value) Sets the `PseudoHeaderName#METHOD` header

method	back to summary
public CharSequence method() Gets the `PseudoHeaderName#METHOD` header or `null` if there is no such header

path	back to summary
public Http2Headers path(CharSequence value) Sets the `PseudoHeaderName#PATH` header

path	back to summary
public CharSequence path() Gets the `PseudoHeaderName#PATH` header or `null` if there is no such header

scheme	back to summary
public Http2Headers scheme(CharSequence value) Sets the `PseudoHeaderName#SCHEME` header

scheme	back to summary
public CharSequence scheme() Gets the `PseudoHeaderName#SCHEME` header or `null` if there is no such header

status	back to summary
public Http2Headers status(CharSequence value) Sets the `PseudoHeaderName#STATUS` header

status	back to summary
public CharSequence status() Gets the `PseudoHeaderName#STATUS` header or `null` if there is no such header

valueIterator back to summary

valueIterator	back to summary
public Iterator<CharSequence> valueIterator(CharSequence name) Equivalent to `getAll(Object)` but no intermediate list is generated. Parameters name:CharSequence the name of the header to retrieve Returns:Iterator<CharSequence> an `Iterator` of header values corresponding to `name`.

public Iterator<CharSequence> valueIterator(CharSequence name)

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

Parameters

name:CharSequence: the name of the header to retrieve

Returns:Iterator<CharSequence>

an Iterator of header values corresponding to name.

io.netty.handler.codec.http2 back to summary

public final Enum Http2Headers.PseudoHeaderName

Class Inheritance

extends Enum<Http2Headers.PseudoHeaderName>

java.lang.Object
java.lang.Enum
io.netty.handler.codec.http2.Http2Headers.PseudoHeaderName

HTTP/2 pseudo-headers names.

Field Summary

Modifier and Type	Field and Description
public static final Http2Headers.PseudoHeaderName	AUTHORITY `:authority`.
public static final Http2Headers.PseudoHeaderName	METHOD `:method`.
public static final Http2Headers.PseudoHeaderName	PATH `:path`.
public static final Http2Headers.PseudoHeaderName	PROTOCOL `:protocol`, as defined in RFC 8441, Bootstrapping WebSockets with HTTP/2.
private static final char	PSEUDO_HEADER_PREFIX
private static final byte	PSEUDO_HEADER_PREFIX_BYTE
private final boolean	requestOnly
public static final Http2Headers.PseudoHeaderName	SCHEME `:scheme`.
public static final Http2Headers.PseudoHeaderName	STATUS `:status`.
private final AsciiString	value

Constructor Summary

Access	Constructor and Description
private	PseudoHeaderName(String value, boolean requestOnly)

Method Summary

Modifier and Type	Method and Description
public static Http2Headers.PseudoHeaderName	Returns: corresponding `PseudoHeaderName` if any, `null` otherwise. getPseudoHeader(CharSequence header) Returns the `PseudoHeaderName` corresponding to the specified header name.
public static Http2Headers.PseudoHeaderName	Returns: corresponding `PseudoHeaderName` if any, `null` otherwise. getPseudoHeader(AsciiString header) Returns the `PseudoHeaderName` corresponding to the specified header name.
private static Http2Headers.PseudoHeaderName	getPseudoHeaderName(CharSequence header)
public static boolean	Returns: `true` if the header follow the pseudo-header format hasPseudoHeaderFormat(CharSequence headerName) Indicates whether the specified header follows the pseudo-header format (begins with ':' character)
public static boolean	isPseudoHeader(CharSequence header) Indicates whether the given header name is a valid HTTP/2 pseudo header.
public static boolean	isPseudoHeader(AsciiString header) Indicates whether the given header name is a valid HTTP/2 pseudo header.
public static boolean	isPseudoHeader(String header) Indicates whether the given header name is a valid HTTP/2 pseudo header.
public boolean	Returns: `true` if the pseudo-header is to be used in a request context isRequestOnly() Indicates whether the pseudo-header is to be used in a request context.
public AsciiString	value()
public static Http2Headers.PseudoHeaderName	valueOf(String name)
public static Http2Headers.PseudoHeaderName[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

AUTHORITY	back to summary
public static final Http2Headers.PseudoHeaderName AUTHORITY `:authority`.

METHOD	back to summary
public static final Http2Headers.PseudoHeaderName METHOD `:method`.

PATH	back to summary
public static final Http2Headers.PseudoHeaderName PATH `:path`.

PROTOCOL	back to summary
public static final Http2Headers.PseudoHeaderName PROTOCOL `:protocol`, as defined in RFC 8441, Bootstrapping WebSockets with HTTP/2.

PSEUDO_HEADER_PREFIX	back to summary
private static final char PSEUDO_HEADER_PREFIX

PSEUDO_HEADER_PREFIX_BYTE	back to summary
private static final byte PSEUDO_HEADER_PREFIX_BYTE

requestOnly	back to summary
private final boolean requestOnly

SCHEME	back to summary
public static final Http2Headers.PseudoHeaderName SCHEME `:scheme`.

STATUS	back to summary
public static final Http2Headers.PseudoHeaderName STATUS `:status`.

value	back to summary
private final AsciiString value

Constructor Detail

PseudoHeaderName	back to summary
private PseudoHeaderName(String value, boolean requestOnly)

Method Detail

getPseudoHeader back to summary

getPseudoHeader	back to summary
public static Http2Headers.PseudoHeaderName getPseudoHeader(CharSequence header) Returns the `PseudoHeaderName` corresponding to the specified header name. Returns:Http2Headers.PseudoHeaderName corresponding `PseudoHeaderName` if any, `null` otherwise.

public static Http2Headers.PseudoHeaderName getPseudoHeader(CharSequence header)

Returns the PseudoHeaderName corresponding to the specified header name.

Returns:Http2Headers.PseudoHeaderName: corresponding PseudoHeaderName if any, null otherwise.

getPseudoHeader back to summary

getPseudoHeader	back to summary
public static Http2Headers.PseudoHeaderName getPseudoHeader(AsciiString header) Returns the `PseudoHeaderName` corresponding to the specified header name. Returns:Http2Headers.PseudoHeaderName corresponding `PseudoHeaderName` if any, `null` otherwise.

public static Http2Headers.PseudoHeaderName getPseudoHeader(AsciiString header)

Returns the PseudoHeaderName corresponding to the specified header name.

Returns:Http2Headers.PseudoHeaderName: corresponding PseudoHeaderName if any, null otherwise.

getPseudoHeaderName	back to summary
private static Http2Headers.PseudoHeaderName getPseudoHeaderName(CharSequence header)

hasPseudoHeaderFormat back to summary

hasPseudoHeaderFormat	back to summary
public static boolean hasPseudoHeaderFormat(CharSequence headerName) Indicates whether the specified header follows the pseudo-header format (begins with ':' character) Returns:boolean `true` if the header follow the pseudo-header format

public static boolean hasPseudoHeaderFormat(CharSequence headerName)

Indicates whether the specified header follows the pseudo-header format (begins with ':' character)

Returns:boolean: true if the header follow the pseudo-header format

isPseudoHeader	back to summary
public static boolean isPseudoHeader(CharSequence header) Indicates whether the given header name is a valid HTTP/2 pseudo header.

isPseudoHeader	back to summary
public static boolean isPseudoHeader(AsciiString header) Indicates whether the given header name is a valid HTTP/2 pseudo header.

isPseudoHeader	back to summary
public static boolean isPseudoHeader(String header) Indicates whether the given header name is a valid HTTP/2 pseudo header.

isRequestOnly back to summary

isRequestOnly	back to summary
public boolean isRequestOnly() Indicates whether the pseudo-header is to be used in a request context. Returns:boolean `true` if the pseudo-header is to be used in a request context

public boolean isRequestOnly()

Indicates whether the pseudo-header is to be used in a request context.

Returns:boolean: true if the pseudo-header is to be used in a request context

value	back to summary
public AsciiString value()

valueOf	back to summary
public static Http2Headers.PseudoHeaderName valueOf(String name)

values	back to summary
public static Http2Headers.PseudoHeaderName[] values()

public Interface Http2Headers

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum Http2Headers.PseudoHeaderName

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail