io.netty.incubator.codec.http3

Enum Http3Headers.PseudoHeaderName

java.lang.Object

java.lang.Enum<Http3Headers.PseudoHeaderName>

io.netty.incubator.codec.http3.Http3Headers.PseudoHeaderName

All Implemented Interfaces:

Serializable, Comparable<Http3Headers.PseudoHeaderName>

Enclosing interface:

Http3Headers

public static enum Http3Headers.PseudoHeaderName
extends Enum<Http3Headers.PseudoHeaderName>

HTTP/2 (and HTTP/3) pseudo-headers names.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHORITY :authority.
METHOD :method.
PATH :path.
SCHEME :scheme.
STATUS :status.

Method Summary

Modifier and Type	Method and Description
static Http3Headers.PseudoHeaderName	getPseudoHeader(CharSequence name) Returns the Http3Headers.PseudoHeaderName corresponding to the specified header name.
static boolean	hasPseudoHeaderFormat(CharSequence headerName) Indicates whether the specified header follows the pseudo-header format (begins with ':' character)
static boolean	isPseudoHeader(CharSequence name) Indicates whether the given header name is a valid HTTP/3 pseudo header.
boolean	isRequestOnly() Indicates whether the pseudo-header is to be used in a request context.
io.netty.util.AsciiString	value()
static Http3Headers.PseudoHeaderName	valueOf(String name) Returns the enum constant of this type with the specified name.
static Http3Headers.PseudoHeaderName[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

METHOD

public static final Http3Headers.PseudoHeaderName METHOD

:method.

SCHEME

public static final Http3Headers.PseudoHeaderName SCHEME

:scheme.

AUTHORITY

public static final Http3Headers.PseudoHeaderName AUTHORITY

:authority.

PATH

public static final Http3Headers.PseudoHeaderName PATH

:path.

STATUS

public static final Http3Headers.PseudoHeaderName STATUS

:status.

Method Detail

values

public static Http3Headers.PseudoHeaderName[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Http3Headers.PseudoHeaderName c : Http3Headers.PseudoHeaderName.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Http3Headers.PseudoHeaderName valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

value

public io.netty.util.AsciiString value()

hasPseudoHeaderFormat

public static boolean hasPseudoHeaderFormat(CharSequence headerName)

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

Parameters:

headerName - the header name to check.

Returns:

true if the header follow the pseudo-header format

isPseudoHeader

public static boolean isPseudoHeader(CharSequence name)

Indicates whether the given header name is a valid HTTP/3 pseudo header.

Parameters:

name - the header name.

Returns:

true if the given header name is a valid HTTP/3 pseudo header, false otherwise.

getPseudoHeader

public static Http3Headers.PseudoHeaderName getPseudoHeader(CharSequence name)

Returns the Http3Headers.PseudoHeaderName corresponding to the specified header name.

Parameters:

name - the header name.

Returns:

corresponding Http3Headers.PseudoHeaderName if any, null otherwise.

isRequestOnly

public boolean isRequestOnly()

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

Returns:

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