ResponseHeaders (filter-service-metrics 1.13 1.13 API)

All Superinterfaces:

HttpHeaders, HttpObject
```
public interface ResponseHeaders
extends HttpHeaders
```
Immutable HTTP/2 headers for an HttpResponse.

See Also:

HttpHeaders, RequestHeaders

Field Summary
- Fields inherited from interface com.linecorp.armeria.common.HttpHeaders
  EMPTY_HEADERS

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static ResponseHeadersBuilder`	`builder()` Returns a new empty builder.
`static ResponseHeadersBuilder`	`builder(HttpStatus status)` Returns a new builder with the specified `HttpStatus`.
`static ResponseHeadersBuilder`	`builder(int statusCode)` Returns a new builder with the specified `statusCode`.
`boolean`	`contains(CharSequence name)` Returns `true` if a header with the `name` exists, `false` otherwise.
`boolean`	`contains(CharSequence name, String value)` Returns `true` if a header with the `name` and `value` exists.
`boolean`	`containsDouble(CharSequence name, double value)` Returns `true` if a header with the `name` and `value` exists.
`boolean`	`containsFloat(CharSequence name, float value)` Returns `true` if a header with the `name` and `value` exists.
`boolean`	`containsInt(CharSequence name, int value)` Returns `true` if a header with the `name` and `value` exists.
`boolean`	`containsLong(CharSequence name, long value)` Returns `true` if a header with the `name` and `value` exists.
`boolean`	`containsObject(CharSequence name, Object value)` Returns `true` if a header with the `name` and `value` exists.
`boolean`	`containsTimeMillis(CharSequence name, long value)` Returns `true` if a header with the `name` and `value` exists.
`MediaType`	`contentType()` Returns the parsed `"content-type"` header.
`void`	`forEach(BiConsumer<io.netty.util.AsciiString,String> action)` Invokes the specified `action` for all header entries.
`void`	`forEachValue(CharSequence name, Consumer<String> action)` Invokes the specified `action` for all values of the headers with the specified `name`.
`String`	`get(CharSequence name)` Returns the value of a header with the specified `name`.
`String`	`get(CharSequence name, String defaultValue)` Returns the value of a header with the specified `name`.
`List<String>`	`getAll(CharSequence name)` Returns all values for the header with the specified name.
`Double`	`getDouble(CharSequence name)` Returns the `double` value of a header with the specified `name`.
`double`	`getDouble(CharSequence name, double defaultValue)` Returns the `double` value of a header with the specified `name`.
`Float`	`getFloat(CharSequence name)` Returns the `float` value of a header with the specified `name`.
`float`	`getFloat(CharSequence name, float defaultValue)` Returns the `float` value of a header with the specified `name`.
`Integer`	`getInt(CharSequence name)` Returns the `int` value of a header with the specified `name`.
`int`	`getInt(CharSequence name, int defaultValue)` Returns the `int` value of a header with the specified `name`.
`Long`	`getLong(CharSequence name)` Returns the `long` value of a header with the specified `name`.
`long`	`getLong(CharSequence name, long defaultValue)` Returns the `long` value of a header with the specified `name`.
`Long`	`getTimeMillis(CharSequence name)` Returns the value of a header with the specified `name` in milliseconds.
`long`	`getTimeMillis(CharSequence name, long defaultValue)` Returns the value of a header with the specified `name` in milliseconds.
`boolean`	`isEmpty()` Returns `true` if this headers does not contain any entries.
`boolean`	`isEndOfStream()` Tells whether the headers correspond to the last frame in an HTTP/2 stream.
`Iterator<Map.Entry<io.netty.util.AsciiString,String>>`	`iterator()` Returns an `Iterator` that yields all header entries.
`Set<io.netty.util.AsciiString>`	`names()` Returns a `Set` of all header names.
`static ResponseHeaders`	`of(HttpHeaders headers)` Returns a new `ResponseHeaders` copied from the specified `HttpHeaders`.
`static ResponseHeaders`	`of(HttpStatus status)` Returns a new `ResponseHeaders` with the specified `HttpStatus`.
`static ResponseHeaders`	`of(HttpStatus status, CharSequence name, Object value)` Returns a new `ResponseHeaders` with the specified `HttpStatus` and an additional header.
`static ResponseHeaders`	`of(HttpStatus status, CharSequence name1, Object value1, CharSequence name2, Object value2)` Returns a new `ResponseHeaders` with the specified `HttpStatus` and additional headers.
`static ResponseHeaders`	`of(HttpStatus status, CharSequence name1, Object value1, CharSequence name2, Object value2, CharSequence name3, Object value3)` Returns a new `ResponseHeaders` with the specified `HttpStatus` and additional headers.
`static ResponseHeaders`	`of(HttpStatus status, CharSequence name1, Object value1, CharSequence name2, Object value2, CharSequence name3, Object value3, CharSequence name4, Object value4)` Returns a new `ResponseHeaders` with the specified `HttpStatus` and additional headers.
`static ResponseHeaders`	`of(HttpStatus status, CharSequence name, String value)` Returns a new `ResponseHeaders` with the specified `HttpStatus` and an additional header.
`static ResponseHeaders`	`of(HttpStatus status, CharSequence name1, String value1, CharSequence name2, String value2)` Returns a new `ResponseHeaders` with the specified `HttpStatus` and additional headers.
`static ResponseHeaders`	`of(HttpStatus status, CharSequence name1, String value1, CharSequence name2, String value2, CharSequence name3, String value3)` Returns a new `ResponseHeaders` with the specified `HttpStatus` and additional headers.
`static ResponseHeaders`	`of(HttpStatus status, CharSequence name1, String value1, CharSequence name2, String value2, CharSequence name3, String value3, CharSequence name4, String value4)` Returns a new `ResponseHeaders` with the specified `HttpStatus` and additional headers.
`static ResponseHeaders`	`of(int statusCode)` Returns a new `ResponseHeaders` with the specified `statusCode`.
`int`	`size()` Returns the number of headers.
`HttpStatus`	`status()` Returns the value of the `":status"` header as an `HttpStatus`.
`default Stream<Map.Entry<io.netty.util.AsciiString,String>>`	`stream()` Returns a `Stream` that yields all header entries.
`ResponseHeadersBuilder`	`toBuilder()` Returns a new builder created from the entries of this headers.
`Iterator<String>`	`valueIterator(CharSequence name)` Returns an `Iterator` that yields all values of the headers with the specified `name`.
`default Stream<String>`	`valueStream(CharSequence name)` Returns a `Stream` that yields all values of the headers with the specified `name`.
`default ResponseHeaders`	`withMutations(Consumer<HttpHeadersBuilder> mutator)` Returns a new headers which is the result from the mutation by the specified `Consumer`.

Methods inherited from interface com.linecorp.armeria.common.HttpHeaders
of, of, of, of, of, of, of, of, of

Methods inherited from interface com.linecorp.armeria.common.HttpObject
isEndOfStream

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - builder
```
static ResponseHeadersBuilder builder()
```
    Returns a new empty builder.
    
    Specified by:
    
    builder in interface HttpHeaders
  - builder
```
static ResponseHeadersBuilder builder(int statusCode)
```
    Returns a new builder with the specified statusCode.
  - builder
```
static ResponseHeadersBuilder builder(HttpStatus status)
```
    Returns a new builder with the specified HttpStatus.
  - of
```
static ResponseHeaders of(int statusCode)
```
    Returns a new ResponseHeaders with the specified statusCode.
  - of
```
static ResponseHeaders of(HttpStatus status)
```
    Returns a new ResponseHeaders with the specified HttpStatus.
  - of
```
static ResponseHeaders of(HttpStatus status,
                          CharSequence name,
                          String value)
```
    Returns a new ResponseHeaders with the specified HttpStatus and an additional header.
  - of
```
static ResponseHeaders of(HttpStatus status,
                          CharSequence name,
                          Object value)
```
    Returns a new ResponseHeaders with the specified HttpStatus and an additional header. The value is converted into a String as explained in Specifying a non-String header value.
  - of
```
static ResponseHeaders of(HttpStatus status,
                          CharSequence name1,
                          String value1,
                          CharSequence name2,
                          String value2)
```
    Returns a new ResponseHeaders with the specified HttpStatus and additional headers.
  - of
```
static ResponseHeaders of(HttpStatus status,
                          CharSequence name1,
                          Object value1,
                          CharSequence name2,
                          Object value2)
```
    Returns a new ResponseHeaders with the specified HttpStatus and additional headers. The values are converted into Strings as explained in Specifying a non-String header value.
  - of
```
static ResponseHeaders of(HttpStatus status,
                          CharSequence name1,
                          String value1,
                          CharSequence name2,
                          String value2,
                          CharSequence name3,
                          String value3)
```
    Returns a new ResponseHeaders with the specified HttpStatus and additional headers.
  - of
```
static ResponseHeaders of(HttpStatus status,
                          CharSequence name1,
                          Object value1,
                          CharSequence name2,
                          Object value2,
                          CharSequence name3,
                          Object value3)
```
    Returns a new ResponseHeaders with the specified HttpStatus and additional headers. The values are converted into Strings as explained in Specifying a non-String header value.
  - of
```
static ResponseHeaders of(HttpStatus status,
                          CharSequence name1,
                          String value1,
                          CharSequence name2,
                          String value2,
                          CharSequence name3,
                          String value3,
                          CharSequence name4,
                          String value4)
```
    Returns a new ResponseHeaders with the specified HttpStatus and additional headers.
  - of
```
static ResponseHeaders of(HttpStatus status,
                          CharSequence name1,
                          Object value1,
                          CharSequence name2,
                          Object value2,
                          CharSequence name3,
                          Object value3,
                          CharSequence name4,
                          Object value4)
```
    Returns a new ResponseHeaders with the specified HttpStatus and additional headers. The values are converted into Strings as explained in Specifying a non-String header value.
  - of
```
static ResponseHeaders of(HttpHeaders headers)
```
    Returns a new ResponseHeaders copied from the specified HttpHeaders.
    
    Throws:
    
    IllegalArgumentException - if the specified HttpHeaders does not have ":status" header.
  - toBuilder
```
ResponseHeadersBuilder toBuilder()
```
    Description copied from interface: HttpHeaders
    
    Returns a new builder created from the entries of this headers.
    
    Specified by:
    
    toBuilder in interface HttpHeaders
    
    See Also:
    
    HttpHeaders.withMutations(Consumer)
  - withMutations
```
default ResponseHeaders withMutations(Consumer<HttpHeadersBuilder> mutator)
```
    Description copied from interface: HttpHeaders
    Returns a new headers which is the result from the mutation by the specified Consumer. This method is a shortcut for:
```
 builder = toBuilder();
 mutator.accept(builder);
 return builder.build();
 
```
    Specified by:
    
    withMutations in interface HttpHeaders
    
    See Also:
    
    HttpHeaders.toBuilder()
  - status
```
HttpStatus status()
```
    Returns the value of the ":status" header as an HttpStatus. If the value is malformed, HttpStatus.UNKNOWN will be returned.
    
    Throws:
    
    IllegalStateException - if there is no such header.
  - isEndOfStream
```
boolean isEndOfStream()
```
    Tells whether the headers correspond to the last frame in an HTTP/2 stream.
  - contentType
```
MediaType contentType()
```
    Returns the parsed "content-type" header.
    
    Returns:
    
    the parsed MediaType if present and valid, or null otherwise.
  - get
```
String get(CharSequence name)
```
    Returns the value of a header with the specified name. If there are more than one value for the specified name, the first value in insertion order is returned.
    
    Parameters:
    
    name - the name of the header to retrieve
    
    Returns:
    
    the first header value if the header is found, or null if there's no such header
  - get
```
String get(CharSequence name,
           String defaultValue)
```
    Returns the value of a header with the specified name. If there are more than one value for the specified name, the first value in insertion order is returned.
    
    Parameters:
    
    name - the name of the header to retrieve
    
    defaultValue - the default value
    
    Returns:
    
    the first header value or defaultValue if there is no such header
  - getAll
```
List<String> getAll(CharSequence name)
```
    Returns all values for the header with the specified name. The returned List can't be modified.
    
    Parameters:
    
    name - the name of the header to retrieve
    
    Returns:
    
    a List of header values or an empty List if there is no such header.
  - getInt
```
Integer getInt(CharSequence name)
```
    Returns the int value of a header with the specified name. If there are more than one value for the specified name, the first value in insertion order is returned.
    
    Parameters:
    
    name - the name of the header to retrieve
    
    Returns:
    
    the int value of the first value in insertion order or null if there is no such header or it can't be converted to int.
  - getInt
```
int getInt(CharSequence name,
           int defaultValue)
```
    Returns the int value of a header with the specified name. If there are more than one value for the specified name, the first value in insertion order is returned.
    
    Parameters:
    
    name - the name of the header to retrieve
    
    defaultValue - the default value
    
    Returns:
    
    the int value of the first value in insertion order or defaultValue if there is no such header or it can't be converted to int.
  - getLong
```
Long getLong(CharSequence name)
```
    Returns the long value of a header with the specified name. If there are more than one value for the specified name, the first value in insertion order is returned.
    
    Parameters:
    
    name - the name of the header to retrieve
    
    Returns:
    
    the long value of the first value in insertion order or null if there is no such header or it can't be converted to long.
  - getLong
```
long getLong(CharSequence name,
             long defaultValue)
```
    Returns the long value of a header with the specified name. If there are more than one value for the specified name, the first value in insertion order is returned.
    
    Parameters:
    
    name - the name of the header to retrieve
    
    defaultValue - the default value
    
    Returns:
    
    the long value of the first value in insertion order or defaultValue if there is no such header or it can't be converted to long.
  - getFloat
```
Float getFloat(CharSequence name)
```
    Returns the float value of a header with the specified name. If there are more than one value for the specified name, the first value in insertion order is returned.
    
    Parameters:
    
    name - the name of the header to retrieve
    
    Returns:
    
    the float value of the first value in insertion order or null if there is no such header or it can't be converted to float.
  - getFloat
```
float getFloat(CharSequence name,
               float defaultValue)
```
    Returns the float value of a header with the specified name. If there are more than one value for the specified name, the first value in insertion order is returned.
    
    Parameters:
    
    name - the name of the header to retrieve
    
    defaultValue - the default value
    
    Returns:
    
    the float value of the first value in insertion order or defaultValue if there is no such header or it can't be converted to float.
  - getDouble
```
Double getDouble(CharSequence name)
```
    Returns the double value of a header with the specified name. If there are more than one value for the specified name, the first value in insertion order is returned.
    
    Parameters:
    
    name - the name of the header to retrieve
    
    Returns:
    
    the double value of the first value in insertion order or null if there is no such header or it can't be converted to double.
  - getDouble
```
double getDouble(CharSequence name,
                 double defaultValue)
```
    Returns the double value of a header with the specified name. If there are more than one value for the specified name, the first value in insertion order is returned.
    
    Parameters:
    
    name - the name of the header to retrieve
    
    defaultValue - the default value
    
    Returns:
    
    the double value of the first value in insertion order or defaultValue if there is no such header or it can't be converted to double.
  - getTimeMillis
```
Long getTimeMillis(CharSequence name)
```
    Returns the value of a header with the specified name in milliseconds. If there are more than one value for the specified name, the first value in insertion order is returned.
    
    Parameters:
    
    name - the name of the header to retrieve
    
    Returns:
    
    the milliseconds value of the first value in insertion order or null if there is no such header or it can't be converted to milliseconds.
  - getTimeMillis
```
long getTimeMillis(CharSequence name,
                   long defaultValue)
```
    Returns the value of a header with the specified name in milliseconds. If there are more than one value for the specified name, the first value in insertion order is returned.
    
    Parameters:
    
    name - the name of the header to retrieve
    
    defaultValue - the default value
    
    Returns:
    
    the milliseconds value of the first value in insertion order or defaultValue if there is no such header or it can't be converted to milliseconds.
  - contains
```
boolean contains(CharSequence name)
```
    Returns true if a header with the name exists, false otherwise.
    
    Parameters:
    
    name - the header name
  - contains
```
boolean contains(CharSequence name,
                 String value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    
    name - the header name
    
    value - the header value of the header to find
  - containsObject
```
boolean containsObject(CharSequence name,
                       Object value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    
    name - the header name
    
    value - the header value
    
    Returns:
    
    true if the header exists. false otherwise
  - containsInt
```
boolean containsInt(CharSequence name,
                    int value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    
    name - the header name
    
    value - the header value
    
    Returns:
    
    true if the header exists. false otherwise
  - containsLong
```
boolean containsLong(CharSequence name,
                     long value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    
    name - the header name
    
    value - the header value
    
    Returns:
    
    true if the header exists. false otherwise
  - containsFloat
```
boolean containsFloat(CharSequence name,
                      float value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    
    name - the header name
    
    value - the header value
    
    Returns:
    
    true if the header exists. false otherwise
  - containsDouble
```
boolean containsDouble(CharSequence name,
                       double value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    
    name - the header name
    
    value - the header value
    
    Returns:
    
    true if the header exists. false otherwise
  - containsTimeMillis
```
boolean containsTimeMillis(CharSequence name,
                           long value)
```
    Returns true if a header with the name and value exists.
    
    Parameters:
    
    name - the header name
    
    value - the header value
    
    Returns:
    
    true if the header exists. false otherwise
  - size
```
int size()
```
    Returns the number of headers.
  - isEmpty
```
boolean isEmpty()
```
    Returns true if this headers does not contain any entries.
  - names
```
Set<io.netty.util.AsciiString> names()
```
    Returns a Set of all header names. The returned Set cannot be modified.
  - iterator
```
Iterator<Map.Entry<io.netty.util.AsciiString,String>> iterator()
```
    Returns an Iterator that yields all header entries. The iteration order is as follows:
    1. All pseudo headers (order not specified).
    2. All non-pseudo headers (in insertion order).
  - valueIterator
```
Iterator<String> valueIterator(CharSequence name)
```
    Returns an Iterator that yields all values of the headers with the specified name.
  - forEach
```
void forEach(BiConsumer<io.netty.util.AsciiString,String> action)
```
    Invokes the specified action for all header entries.
  - forEachValue
```
void forEachValue(CharSequence name,
                  Consumer<String> action)
```
    Invokes the specified action for all values of the headers with the specified name.
  - stream
```
default Stream<Map.Entry<io.netty.util.AsciiString,String>> stream()
```
    Returns a Stream that yields all header entries.
  - valueStream
```
default Stream<String> valueStream(CharSequence name)
```
    Returns a Stream that yields all values of the headers with the specified name.

Interface ResponseHeaders

Field Summary

Fields inherited from interface com.linecorp.armeria.common.HttpHeaders

Method Summary

Methods inherited from interface com.linecorp.armeria.common.HttpHeaders

Methods inherited from interface com.linecorp.armeria.common.HttpObject

Methods inherited from interface java.lang.Iterable

Method Detail

builder

builder

builder

of

of

of

of

of

of

of

of

of

of

of

toBuilder

withMutations

status

isEndOfStream

contentType

get

get

getAll

getInt

getInt

getLong

getLong

getFloat

getFloat

getDouble

getDouble

getTimeMillis

getTimeMillis

contains

contains

containsObject

containsInt

containsLong

containsFloat

containsDouble

containsTimeMillis

size

isEmpty

names

iterator

valueIterator

forEach

forEachValue

stream

valueStream