Package io.netty5.handler.codec.http2.headers

Interface Http2Headers

All Superinterfaces:

io.netty5.handler.codec.http.headers.HttpHeaders, Iterable<Map.Entry<CharSequence,CharSequence>>

All Known Implementing Classes:

DefaultHttp2Headers

public interface Http2Headers
extends io.netty5.handler.codec.http.headers.HttpHeaders

HTTP/2 headers. This works similar to HttpHeaders with the following HTTP/2 specific modifications:

• Pseudo-headers always come before all other headers when iterated.
• Header field names are always lower-case.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Http2Headers.PseudoHeaderName	HTTP/2 pseudo-headers names.

Method Summary

Modifier and Type	Method	Description
Http2Headers	add(io.netty5.handler.codec.http.headers.HttpHeaders headers)
Http2Headers	add(CharSequence name, CharSequence value)
Http2Headers	add(CharSequence name, CharSequence... values)
Http2Headers	add(CharSequence name, Iterable<? extends CharSequence> values)
default Http2Headers	add(CharSequence name, Iterator<? extends CharSequence> valuesItr)
Http2Headers	addCookie(io.netty5.handler.codec.http.headers.HttpCookiePair cookie)
default Http2Headers	addCookie(CharSequence name, CharSequence value)
Http2Headers	addSetCookie(io.netty5.handler.codec.http.headers.HttpSetCookie cookie)
default Http2Headers	addSetCookie(CharSequence name, CharSequence value)
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()
Http2Headers	copy()
static Http2Headers	emptyHeaders()	Create a headers instance that is expected to remain empty.
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
static Http2Headers	newHeaders()	Create a header instance with default size hint, and all validation checks turned on.
static Http2Headers	newHeaders(boolean validate)	Create a headers instance with default size hint, and all validation checks turned on.
static Http2Headers	newHeaders(int sizeHint, boolean checkNames, boolean checkCookies, boolean checkValues)	Create a header instance with the given size hint, and the given validation checks turned on.
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
default Http2Headers	replace(io.netty5.handler.codec.http.headers.HttpHeaders headers)
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
default Http2Headers	set(io.netty5.handler.codec.http.headers.HttpHeaders headers)
Http2Headers	set(CharSequence name, CharSequence value)
default Http2Headers	set(CharSequence name, CharSequence... values)
Http2Headers	set(CharSequence name, Iterable<? extends CharSequence> values)
default Http2Headers	set(CharSequence name, Iterator<? extends CharSequence> valueItr)
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

Methods inherited from interface io.netty5.handler.codec.http.headers.HttpHeaders

contains, contains, containsIgnoreCase, get, get, getAndRemove, getAndRemove, getCookie, getCookies, getCookies, getCookiesIterator, getCookiesIterator, getSetCookie, getSetCookies, getSetCookies, getSetCookies, getSetCookiesIterator, getSetCookiesIterator, getSetCookiesIterator, isEmpty, iterator, names, remove, remove, removeCookies, removeIgnoreCase, removeSetCookies, removeSetCookies, size, spliterator, toString, toString, values, valuesIterator

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

emptyHeaders

static Http2Headers emptyHeaders()

Create a headers instance that is expected to remain empty.

Returns:

A new headers instance that use up as few resources as possible.

newHeaders

static Http2Headers newHeaders()

Create a header instance with default size hint, and all validation checks turned on.

Returns:

A new empty header instance.

newHeaders

static Http2Headers newHeaders(boolean validate)

Create a headers instance with default size hint, and all validation checks turned on.

Parameters:

validate - true to validate header names, values, and cookies.

Returns:

A new empty headers instance.

newHeaders

static Http2Headers newHeaders(int sizeHint,
                               boolean checkNames,
                               boolean checkCookies,
                               boolean checkValues)

Create a header instance with the given size hint, and the given validation checks turned on.

Returns:

A new empty header instance with the given configuration.

copy

Http2Headers copy()

Specified by:

copy in interface io.netty5.handler.codec.http.headers.HttpHeaders

add

Http2Headers add(CharSequence name,
                 CharSequence value)

Specified by:

add in interface io.netty5.handler.codec.http.headers.HttpHeaders

add

Http2Headers add(CharSequence name,
                 Iterable<? extends CharSequence> values)

Specified by:

add in interface io.netty5.handler.codec.http.headers.HttpHeaders

add

default Http2Headers add(CharSequence name,
                         Iterator<? extends CharSequence> valuesItr)

Specified by:

add in interface io.netty5.handler.codec.http.headers.HttpHeaders

add

Http2Headers add(CharSequence name,
                 CharSequence... values)

Specified by:

add in interface io.netty5.handler.codec.http.headers.HttpHeaders

add

Http2Headers add(io.netty5.handler.codec.http.headers.HttpHeaders headers)

Specified by:

add in interface io.netty5.handler.codec.http.headers.HttpHeaders

set

Http2Headers set(CharSequence name,
                 CharSequence value)

Specified by:

set in interface io.netty5.handler.codec.http.headers.HttpHeaders

set

Http2Headers set(CharSequence name,
                 Iterable<? extends CharSequence> values)

Specified by:

set in interface io.netty5.handler.codec.http.headers.HttpHeaders

set

default Http2Headers set(CharSequence name,
                         Iterator<? extends CharSequence> valueItr)

Specified by:

set in interface io.netty5.handler.codec.http.headers.HttpHeaders

set

default Http2Headers set(CharSequence name,
                         CharSequence... values)

Specified by:

set in interface io.netty5.handler.codec.http.headers.HttpHeaders

set

default Http2Headers set(io.netty5.handler.codec.http.headers.HttpHeaders headers)

Specified by:

set in interface io.netty5.handler.codec.http.headers.HttpHeaders

replace

default Http2Headers replace(io.netty5.handler.codec.http.headers.HttpHeaders headers)

Specified by:

replace in interface io.netty5.handler.codec.http.headers.HttpHeaders

clear

Http2Headers clear()

Specified by:

clear in interface io.netty5.handler.codec.http.headers.HttpHeaders

addCookie

Http2Headers addCookie(io.netty5.handler.codec.http.headers.HttpCookiePair cookie)

Specified by:

addCookie in interface io.netty5.handler.codec.http.headers.HttpHeaders

addCookie

default Http2Headers addCookie(CharSequence name,
                               CharSequence value)

Specified by:

addCookie in interface io.netty5.handler.codec.http.headers.HttpHeaders

addSetCookie

Http2Headers addSetCookie(io.netty5.handler.codec.http.headers.HttpSetCookie cookie)

Specified by:

addSetCookie in interface io.netty5.handler.codec.http.headers.HttpHeaders

addSetCookie

default Http2Headers addSetCookie(CharSequence name,
                                  CharSequence value)

Specified by:

addSetCookie in interface io.netty5.handler.codec.http.headers.HttpHeaders

method

Http2Headers method(CharSequence value)

Sets the Http2Headers.PseudoHeaderName.METHOD header

scheme

Http2Headers scheme(CharSequence value)

Sets the Http2Headers.PseudoHeaderName.SCHEME header

authority

Http2Headers authority(CharSequence value)

Sets the Http2Headers.PseudoHeaderName.AUTHORITY header

path

Http2Headers path(CharSequence value)

Sets the Http2Headers.PseudoHeaderName.PATH header

status

Http2Headers status(CharSequence value)

Sets the Http2Headers.PseudoHeaderName.STATUS header

method

CharSequence method()

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

scheme

CharSequence scheme()

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

authority

CharSequence authority()

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

path

CharSequence path()

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

status

CharSequence status()

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