Interface ServerResponseTrailers

All Superinterfaces:

Headers, Iterable<Header>, WritableHeaders<ServerResponseTrailers>

public interface ServerResponseTrailers
extends WritableHeaders<ServerResponseTrailers>

Mutable trailers of a server response.

Method Summary

Static Methods

Modifier and Type	Method	Description
static ServerResponseTrailers	create()	Create a new instance of mutable server response trailers.
static ServerResponseTrailers	create(Headers existing)	Create a new instance of mutable server response trailers.
static ServerResponseTrailers	wrap(WritableHeaders<?> existing)	Create a new instance of mutable server response trailers by wrapping existing writable trailers.

Methods inherited from interface Headers

acceptedTypes, all, contains, contains, containsToken, contentLength, contentType, find, first, get, isAccepted, size, stream, toMap, value, values

Modifier and Type	Method	Description
List<HttpMediaType>	acceptedTypes()	Returns a list of acceptedTypes (HeaderNames.ACCEPT header) content discoveryTypes in quality factor order.
List<String>	all(HeaderName name, Supplier<List<String>> defaultSupplier)	Get all values of a header.
boolean	contains(Header value)	Whether these headers contain a header with the provided name and value.
boolean	contains(HeaderName name)	Whether these headers contain a header with the provided name.
default boolean	containsToken(Header value)	Whether these headers contain all tokenized values from the provided header.
default OptionalLong	contentLength()	Content length if defined.
default Optional<HttpMediaType>	contentType()	Content type (if defined).
default Optional<Header>	find(HeaderName headerName)	Find the first header.
default Optional<String>	first(HeaderName headerName)	Returns a first header value.
Header	get(HeaderName name)	Get a header value.
default boolean	isAccepted(MediaType... mediaTypes)	Whether this media type is accepted by these headers.
int	size()	Number of headers in these headers.
default Stream<Header>	stream()	A sequential stream with these headers as the source.
default Map<String, List<String>>	toMap()	Deprecated. use other methods to handle headers, preferably using pull approach
default Optional<String>	value(HeaderName headerName)	Returns a header value as a single String potentially concatenated using comma character from Headers.all(HeaderName, java.util.function.Supplier) header fields.
default List<String>	values(HeaderName headerName)	Returns an unmodifiable List of all comma separated header value parts - Such segmentation is NOT valid for all header semantics, however it is very common.

Methods inherited from interface Iterable

forEach, iterator, spliterator

Methods inherited from interface WritableHeaders

add, add, add, add, clear, contentLength, contentType, from, remove, remove, set, set, set, set, set, setIfAbsent

Modifier and Type	Method	Description
ServerResponseTrailers	add(Header header)	Add a header or add a header value if the header is already present.
default ServerResponseTrailers	add(HeaderName header, int value)	Add a header or add a header value if the header is already present.
default ServerResponseTrailers	add(HeaderName header, long value)	Add a header or add a header value if the header is already present.
default ServerResponseTrailers	add(HeaderName header, String... value)	Add a header or add a header value if the header is already present.
ServerResponseTrailers	clear()	Clear all current headers.
default ServerResponseTrailers	contentLength(long length)	Content length of the entity in bytes.
default ServerResponseTrailers	contentType(MediaType contentType)	Sets the MIME type of the response body.
ServerResponseTrailers	from(Headers headers)	For each header from the provided headers, set its value on these headers.
ServerResponseTrailers	remove(HeaderName name)	Remove a header.
ServerResponseTrailers	remove(HeaderName name, Consumer<Header> removedConsumer)	Remove a header.
ServerResponseTrailers	set(Header header)	Set a header and replace it if it already existed.
default ServerResponseTrailers	set(HeaderName name, int value)	Set a header and replace it if it already existed.
default ServerResponseTrailers	set(HeaderName name, long value)	Set a header and replace it if it already existed.
default ServerResponseTrailers	set(HeaderName name, String... values)	Set a header and replace it if it already existed.
default ServerResponseTrailers	set(HeaderName name, Collection<String> values)	Set a header and replace it if it already existed.
ServerResponseTrailers	setIfAbsent(Header header)	Set a value of a header unless it is already present.

Method Details

create

static ServerResponseTrailers create()

Create a new instance of mutable server response trailers.

Returns:

new server response trailers

create

static ServerResponseTrailers create(Headers existing)

Create a new instance of mutable server response trailers.

Parameters:

existing - trailers to add to these response trailers

Returns:

new server response trailers

wrap

static ServerResponseTrailers wrap(WritableHeaders<?> existing)

Create a new instance of mutable server response trailers by wrapping existing writable trailers. Any updates to this class will also impact the underlying trailers.

Parameters:

existing - trailers to wrap

Returns:

new server response trailers