Package ratpack.core.http

Interface Headers

All Known Subinterfaces:

MutableHeaders

public interface Headers

An immutable set of HTTP headers.

Method Summary

Modifier and Type	Method	Description
MultiValueMap<String,String>	asMultiValueMap()
boolean	contains(CharSequence name)	Checks whether a header has been specified for the given value.
boolean	contains(String name)	Checks whether a header has been specified for the given value.
String	get(CharSequence name)	Returns the header value with the specified header name.
String	get(String name)	Returns the header value with the specified header name.
List<String>	getAll(CharSequence name)	Returns all of the header values with the specified header name.
List<String>	getAll(String name)	Returns all of the header values with the specified header name.
Date	getDate(CharSequence name)	Returns the header value as a date with the specified header name.
Date	getDate(String name)	Returns the header value as a date with the specified header name.
default Instant	getInstant(CharSequence name)	Returns the header value as an instant with the specified header name.
Set<String>	getNames()	All header names.
io.netty.handler.codec.http.HttpHeaders	getNettyHeaders()	Returns the headers in their Netty compliant form.

Method Detail

get

@Nullable
String get(CharSequence name)

Returns the header value with the specified header name.

If there is more than one header value for the specified header name, the first value is returned.

Parameters:

name - The case insensitive name of the header to get retrieve the first value of

Returns:

the header value or null if there is no such header

get

@Nullable
String get(String name)

Returns the header value with the specified header name.

If there is more than one header value for the specified header name, the first value is returned.

Parameters:

name - The case insensitive name of the header to get retrieve the first value of

Returns:

the header value or null if there is no such header

getDate

@Nullable
Date getDate(CharSequence name)

Returns the header value as a date with the specified header name.

If there is more than one header value for the specified header name, the first value is returned.

Parameters:

name - The case insensitive name of the header to get retrieve the first value of

Returns:

the header value as a date or null if there is no such header or the header value is not a valid date format

getInstant

@Nullable
default Instant getInstant(CharSequence name)

Returns the header value as an instant with the specified header name.

If there is more than one header value for the specified header name, the first value is returned.

Parameters:

name - the case insensitive name of the header to get retrieve the first value of

Returns:

the header value as an instant or null if there is no such header or the header value is not a valid date format

Since:

1.4

getDate

@Nullable
Date getDate(String name)

Returns the header value as a date with the specified header name.

If there is more than one header value for the specified header name, the first value is returned.

Parameters:

name - The case insensitive name of the header to get retrieve the first value of

Returns:

the header value as a date or null if there is no such header or the header value is not a valid date format

getAll

List<String> getAll(CharSequence name)

Returns all of the header values with the specified header name.

Parameters:

name - The case insensitive name of the header to retrieve all of the values of

Returns:

the List of header values, or an empty list if there is no such header

getAll

List<String> getAll(String name)

Returns all of the header values with the specified header name.

Parameters:

name - The case insensitive name of the header to retrieve all of the values of

Returns:

the List of header values, or an empty list if there is no such header

contains

boolean contains(CharSequence name)

Checks whether a header has been specified for the given value.

Parameters:

name - The name of the header to check the existence of

Returns:

True if there is a header with the specified header name

contains

boolean contains(String name)

Checks whether a header has been specified for the given value.

Parameters:

name - The name of the header to check the existence of

Returns:

True if there is a header with the specified header name

getNames

Set<String> getNames()

All header names.

Returns:

The names of all headers that were sent

getNettyHeaders

io.netty.handler.codec.http.HttpHeaders getNettyHeaders()

Returns the headers in their Netty compliant form.

Use of this method should be avoided, in favor of using the other methods of this interface.

Returns:

the headers in their Netty compliant form

asMultiValueMap

MultiValueMap<String,String> asMultiValueMap()