Package com.linecorp.armeria.common
Interface ResponseHeadersBuilder
- All Superinterfaces:
HttpHeadersBuilder
,Iterable<Map.Entry<io.netty.util.AsciiString,
String>>
Builds a
ResponseHeaders
.-
Method Summary
Modifier and TypeMethodDescriptionadd
(CharSequence name, Iterable<String> values) Adds new headers with the specifiedname
andvalues
.add
(CharSequence name, String value) Adds a new header with the specifiedname
andvalue
.add
(CharSequence name, String... values) Adds new headers with the specifiedname
andvalues
.add
(Iterable<? extends Map.Entry<? extends CharSequence, String>> entries) Adds all header names and values of the specifiedentries
.default ResponseHeadersBuilder
add
(Map<? extends CharSequence, String> entries) Adds all header names and values of the specifiedentries
.addDouble
(CharSequence name, double value) Adds a new header.addFloat
(CharSequence name, float value) Adds a new header.addInt
(CharSequence name, int value) Adds a new header.addLong
(CharSequence name, long value) Adds a new header.addObject
(CharSequence name, Iterable<?> values) Adds a new header with the specified name and values.addObject
(CharSequence name, Object value) Adds a new header.addObject
(CharSequence name, Object... values) Adds a new header with the specified name and values.addObject
(Iterable<? extends Map.Entry<? extends CharSequence, ?>> entries) Adds all header names and values of the specifiedentries
.addTimeMillis
(CharSequence name, long value) Adds a new header.build()
Returns a newly createdResponseHeaders
with the entries in this builder.clear()
Removes all headers.boolean
contains
(CharSequence name) Returnstrue
if a header with thename
exists,false
otherwise.boolean
contains
(CharSequence name, String value) Returnstrue
if a header with thename
andvalue
exists.boolean
containsBoolean
(CharSequence name, boolean value) Returnstrue
if a header with thename
andvalue
exists.boolean
containsDouble
(CharSequence name, double value) Returnstrue
if a header with thename
andvalue
exists.boolean
containsFloat
(CharSequence name, float value) Returnstrue
if a header with thename
andvalue
exists.boolean
containsInt
(CharSequence name, int value) Returnstrue
if a header with thename
andvalue
exists.boolean
containsLong
(CharSequence name, long value) Returnstrue
if a header with thename
andvalue
exists.boolean
containsObject
(CharSequence name, Object value) Returnstrue
if a header with thename
andvalue
exists.boolean
containsTimeMillis
(CharSequence name, long value) Returnstrue
if a header with thename
andvalue
exists.Returns the parsed"content-disposition"
header.contentDisposition
(ContentDisposition contentDisposition) Sets the"content-disposition"
header.long
Returns the value of the content-length header, or-1
if this value is not known.contentLength
(long contentLength) Sets the content-length header.Sets whether the content-length is unknown.Returns the parsed"content-type"
header.contentType
(MediaType contentType) Sets the"content-type"
header.Adds the set-cookie header.cookies()
Returns the parsed set-cookie header.Adds the set-cookie header.Adds the set-cookie header.endOfStream
(boolean endOfStream) Sets whether the headers will be the last frame in an HTTP/2 stream.void
forEach
(BiConsumer<io.netty.util.AsciiString, String> action) Invokes the specifiedaction
for all header entries.void
forEachValue
(CharSequence name, Consumer<String> action) Invokes the specifiedaction
for all values of the headers with the specifiedname
.get
(CharSequence name) Returns the value of a header with the specifiedname
.get
(CharSequence name, String defaultValue) Returns the value of a header with the specifiedname
.getAll
(CharSequence name) Returns all values for the header with the specified name.getBoolean
(CharSequence name) Returns theboolean
value of a header with the specifiedname
.boolean
getBoolean
(CharSequence name, boolean defaultValue) Returns theboolean
value of a header with the specifiedname
.getDouble
(CharSequence name) Returns thedouble
value of a header with the specifiedname
.double
getDouble
(CharSequence name, double defaultValue) Returns thedouble
value of a header with the specifiedname
.getFloat
(CharSequence name) Returns thefloat
value of a header with the specifiedname
.float
getFloat
(CharSequence name, float defaultValue) Returns thefloat
value of a header with the specifiedname
.getInt
(CharSequence name) Returns theint
value of a header with the specifiedname
.int
getInt
(CharSequence name, int defaultValue) Returns theint
value of a header with the specifiedname
.getLast
(CharSequence name) Returns the value of a header with the specifiedname
.getLast
(CharSequence name, String defaultValue) Returns the value of a header with the specifiedname
.getLastBoolean
(CharSequence name) Returns theboolean
value of a header with the specifiedname
.boolean
getLastBoolean
(CharSequence name, boolean defaultValue) Returns theboolean
value of a header with the specifiedname
.getLastDouble
(CharSequence name) Returns thedouble
value of a header with the specifiedname
.double
getLastDouble
(CharSequence name, double defaultValue) Returns thedouble
value of a header with the specifiedname
.getLastFloat
(CharSequence name) Returns thefloat
value of a header with the specifiedname
.float
getLastFloat
(CharSequence name, float defaultValue) Returns thefloat
value of a header with the specifiedname
.getLastInt
(CharSequence name) Returns theint
value of a header with the specifiedname
.int
getLastInt
(CharSequence name, int defaultValue) Returns theint
value of a header with the specifiedname
.getLastLong
(CharSequence name) Returns thelong
value of a header with the specifiedname
.long
getLastLong
(CharSequence name, long defaultValue) Returns thelong
value of a header with the specifiedname
.Returns the value of a header with the specifiedname
in milliseconds.long
getLastTimeMillis
(CharSequence name, long defaultValue) Returns the value of a header with the specifiedname
in milliseconds.getLong
(CharSequence name) Returns thelong
value of a header with the specifiedname
.long
getLong
(CharSequence name, long defaultValue) Returns thelong
value of a header with the specifiedname
.getTimeMillis
(CharSequence name) Returns the value of a header with the specifiedname
in milliseconds.long
getTimeMillis
(CharSequence name, long defaultValue) Returns the value of a header with the specifiedname
in milliseconds.boolean
Returns whether the content length is unknown.boolean
isEmpty()
Returnstrue
if this headers does not contain any entries.boolean
Tells whether the headers correspond to the last frame in an HTTP/2 stream.iterator()
Returns anIterator
that yields all header entries.Set<io.netty.util.AsciiString>
names()
Returns aSet
of all header names.removeAndThen
(CharSequence name) Removes all headers with the specifiedname
.set
(CharSequence name, Iterable<String> values) Sets a new header with the specified name and values.set
(CharSequence name, String value) Sets a header with the specified name and value.set
(CharSequence name, String... values) Sets a header with the specified name and values.set
(Iterable<? extends Map.Entry<? extends CharSequence, String>> entries) Retains all current headers but callsHttpHeadersBuilder.set(CharSequence, String)
for each header in the specifiedentries
.default ResponseHeadersBuilder
set
(Map<? extends CharSequence, String> entries) Retains all current headers but callsHttpHeadersBuilder.set(CharSequence, String)
for each header in the specifiedentries
.setDouble
(CharSequence name, double value) Sets a header with the specifiedname
tovalue
.setFloat
(CharSequence name, float value) Sets a header with the specifiedname
tovalue
.setIfAbsent
(Iterable<? extends Map.Entry<? extends CharSequence, String>> entries) Copies the entries missing in this headers from the specifiedentries
.setInt
(CharSequence name, int value) Sets a header with the specifiedname
tovalue
.setLong
(CharSequence name, long value) Sets a header with the specifiedname
tovalue
.setObject
(CharSequence name, Iterable<?> values) Sets a header with the specified name and values.setObject
(CharSequence name, Object value) Sets a new header.setObject
(CharSequence name, Object... values) Sets a header with the specified name and values.setObject
(Iterable<? extends Map.Entry<? extends CharSequence, ?>> entries) Retains all current headers but callsHttpHeadersBuilder.setObject(CharSequence, Object)
for each entry in the specifiedentries
.setTimeMillis
(CharSequence name, long value) Sets a header with the specifiedname
tovalue
.int
size()
Returns the number of headers.sizeHint
(int sizeHint) Specifies the hint about the number of headers which may improve the memory efficiency and performance of the underlying data structure.status()
Returns the value of the":status"
header as anHttpStatus
.status
(int statusCode) Sets the":status"
header.status
(HttpStatus status) Sets the":status"
header.stream()
Returns aStream
that yields all header entries.valueIterator
(CharSequence name) Returns anIterator
that yields all values of the headers with the specifiedname
.valueStream
(CharSequence name) Returns aStream
that yields all values of the headers with the specifiedname
.Methods inherited from interface com.linecorp.armeria.common.HttpHeadersBuilder
getAllAndRemove, getAndRemove, getAndRemove, getDoubleAndRemove, getDoubleAndRemove, getFloatAndRemove, getFloatAndRemove, getIntAndRemove, getIntAndRemove, getLongAndRemove, getLongAndRemove, getTimeMillisAndRemove, getTimeMillisAndRemove, remove
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Method Details
-
build
ResponseHeaders build()Returns a newly createdResponseHeaders
with the entries in this builder.- Specified by:
build
in interfaceHttpHeadersBuilder
- Throws:
IllegalStateException
- if this builder does not have":status"
header set.
-
status
Sets the":status"
header. -
status
Sets the":status"
header. -
cookie
Adds the set-cookie header. -
cookies
Adds the set-cookie header. -
cookies
Adds the set-cookie header. -
sizeHint
Description copied from interface:HttpHeadersBuilder
Specifies the hint about the number of headers which may improve the memory efficiency and performance of the underlying data structure.- Specified by:
sizeHint
in interfaceHttpHeadersBuilder
- Returns:
this
-
endOfStream
Description copied from interface:HttpHeadersBuilder
Sets whether the headers will be the last frame in an HTTP/2 stream.- Specified by:
endOfStream
in interfaceHttpHeadersBuilder
-
contentLength
Description copied from interface:HttpHeadersBuilder
Sets the content-length header.- Specified by:
contentLength
in interfaceHttpHeadersBuilder
-
contentLengthUnknown
ResponseHeadersBuilder contentLengthUnknown()Description copied from interface:HttpHeadersBuilder
Sets whether the content-length is unknown. Thus,content-length
header is not automatically updated.- Specified by:
contentLengthUnknown
in interfaceHttpHeadersBuilder
-
contentType
Description copied from interface:HttpHeadersBuilder
Sets the"content-type"
header.- Specified by:
contentType
in interfaceHttpHeadersBuilder
-
contentDisposition
Description copied from interface:HttpHeadersBuilder
Sets the"content-disposition"
header.- Specified by:
contentDisposition
in interfaceHttpHeadersBuilder
-
add
Description copied from interface:HttpHeadersBuilder
Adds a new header with the specifiedname
andvalue
.- Specified by:
add
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalue
- the header value- Returns:
this
-
add
Description copied from interface:HttpHeadersBuilder
Adds new headers with the specifiedname
andvalues
. This method is semantically equivalent tofor (String value : values) { builder.add(name, value); }
- Specified by:
add
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalues
- the header values- Returns:
this
-
add
Description copied from interface:HttpHeadersBuilder
Adds new headers with the specifiedname
andvalues
. This method is semantically equivalent tofor (String value : values) { builder.add(name, value); }
- Specified by:
add
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalues
- the header values- Returns:
this
-
add
Description copied from interface:HttpHeadersBuilder
Adds all header names and values of the specifiedentries
.- Specified by:
add
in interfaceHttpHeadersBuilder
- Returns:
this
-
add
Description copied from interface:HttpHeadersBuilder
Adds all header names and values of the specifiedentries
.- Specified by:
add
in interfaceHttpHeadersBuilder
- Returns:
this
-
addObject
Description copied from interface:HttpHeadersBuilder
Adds a new header. The specified header value is converted into aString
, as explained in Specifying a non-String header value.- Specified by:
addObject
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalue
- the header value- Returns:
this
-
addObject
Description copied from interface:HttpHeadersBuilder
Adds a new header with the specified name and values. The specified header values are converted intoString
s, as explained in Specifying a non-String header value. This method is equivalent to:for (Object v : values) { builder.addObject(name, v); }
- Specified by:
addObject
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalues
- the header values- Returns:
this
-
addObject
Description copied from interface:HttpHeadersBuilder
Adds a new header with the specified name and values. The specified header values are converted intoString
s, as explained in Specifying a non-String header value. This method is equivalent to:for (Object v : values) { builder.addObject(name, v); }
- Specified by:
addObject
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalues
- the header values- Returns:
this
-
addObject
Description copied from interface:HttpHeadersBuilder
Adds all header names and values of the specifiedentries
. The specified header values are converted intoString
s, as explained in Specifying a non-String header value.- Specified by:
addObject
in interfaceHttpHeadersBuilder
- Returns:
this
-
addInt
Description copied from interface:HttpHeadersBuilder
Adds a new header.- Specified by:
addInt
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalue
- the header value- Returns:
this
-
addLong
Description copied from interface:HttpHeadersBuilder
Adds a new header.- Specified by:
addLong
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalue
- the header value- Returns:
this
-
addFloat
Description copied from interface:HttpHeadersBuilder
Adds a new header.- Specified by:
addFloat
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalue
- the header value- Returns:
this
-
addDouble
Description copied from interface:HttpHeadersBuilder
Adds a new header.- Specified by:
addDouble
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalue
- the header value- Returns:
this
-
addTimeMillis
Description copied from interface:HttpHeadersBuilder
Adds a new header.- Specified by:
addTimeMillis
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalue
- the header value- Returns:
this
-
set
Description copied from interface:HttpHeadersBuilder
Sets a header with the specified name and value. Any existing headers with the same name are overwritten.- Specified by:
set
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalue
- the header value- Returns:
this
-
set
Description copied from interface:HttpHeadersBuilder
Sets a new header with the specified name and values. This method is equivalent tobuilder.remove(name); for (String v : values) { builder.add(name, v); }
- Specified by:
set
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalues
- the header values- Returns:
this
-
set
Description copied from interface:HttpHeadersBuilder
Sets a header with the specified name and values. Any existing headers with the specified name are removed. This method is equivalent to:builder.remove(name); for (String v : values) { builder.add(name, v); }
- Specified by:
set
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalues
- the header values- Returns:
this
-
set
Description copied from interface:HttpHeadersBuilder
Retains all current headers but callsHttpHeadersBuilder.set(CharSequence, String)
for each header in the specifiedentries
.- Specified by:
set
in interfaceHttpHeadersBuilder
- Parameters:
entries
- the headers used to set the header values- Returns:
this
-
set
Description copied from interface:HttpHeadersBuilder
Retains all current headers but callsHttpHeadersBuilder.set(CharSequence, String)
for each header in the specifiedentries
.- Specified by:
set
in interfaceHttpHeadersBuilder
- Parameters:
entries
- the headers used to set the header values- Returns:
this
-
setIfAbsent
ResponseHeadersBuilder setIfAbsent(Iterable<? extends Map.Entry<? extends CharSequence, String>> entries) Description copied from interface:HttpHeadersBuilder
Copies the entries missing in this headers from the specifiedentries
. This method is a shortcut for:headers.names().forEach(name -> { if (!builder.contains(name)) { builder.set(name, headers.getAll(name)); } });
- Specified by:
setIfAbsent
in interfaceHttpHeadersBuilder
- Returns:
this
-
setObject
Description copied from interface:HttpHeadersBuilder
Sets a new header. Any existing headers with the specified name are removed. The specified header value is converted into aString
, as explained in Specifying a non-String header value.- Specified by:
setObject
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalue
- the value of the header- Returns:
this
-
setObject
Description copied from interface:HttpHeadersBuilder
Sets a header with the specified name and values. Any existing headers with the specified name are removed. The specified header values are converted intoString
s, as explained in Specifying a non-String header value. This method is equivalent to:builder.remove(name); for (Object v : values) { builder.addObject(name, v); }
- Specified by:
setObject
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalues
- the values of the header- Returns:
this
-
setObject
Description copied from interface:HttpHeadersBuilder
Sets a header with the specified name and values. Any existing headers with the specified name are removed. The specified header values are converted intoString
s, as explained in Specifying a non-String header value. This method is equivalent to:builder.remove(name); for (Object v : values) { builder.addObject(name, v); }
- Specified by:
setObject
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalues
- the values of the header- Returns:
this
-
setObject
Description copied from interface:HttpHeadersBuilder
Retains all current headers but callsHttpHeadersBuilder.setObject(CharSequence, Object)
for each entry in the specifiedentries
. The specified header values are converted intoString
s, as explained in Specifying a non-String header value.- Specified by:
setObject
in interfaceHttpHeadersBuilder
- Parameters:
entries
- the headers used to set the values in this instance- Returns:
this
-
setInt
Description copied from interface:HttpHeadersBuilder
Sets a header with the specifiedname
tovalue
. This will remove all previous values associated withname
.- Specified by:
setInt
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalue
- the header value- Returns:
this
-
setLong
Description copied from interface:HttpHeadersBuilder
Sets a header with the specifiedname
tovalue
. This will remove all previous values associated withname
.- Specified by:
setLong
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalue
- the header value- Returns:
this
-
setFloat
Description copied from interface:HttpHeadersBuilder
Sets a header with the specifiedname
tovalue
. This will remove all previous values associated withname
.- Specified by:
setFloat
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalue
- the header value- Returns:
this
-
setDouble
Description copied from interface:HttpHeadersBuilder
Sets a header with the specifiedname
tovalue
. This will remove all previous values associated withname
.- Specified by:
setDouble
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalue
- the header value- Returns:
this
-
setTimeMillis
Description copied from interface:HttpHeadersBuilder
Sets a header with the specifiedname
tovalue
. This will remove all previous values associated withname
.- Specified by:
setTimeMillis
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header namevalue
- the header value- Returns:
this
-
removeAndThen
Description copied from interface:HttpHeadersBuilder
Removes all headers with the specifiedname
. UnlikeHttpHeadersBuilder.remove(CharSequence)
this method returns itself so that the caller can chain the invocations.- Specified by:
removeAndThen
in interfaceHttpHeadersBuilder
- Parameters:
name
- the header name- Returns:
this
-
clear
ResponseHeadersBuilder clear()Description copied from interface:HttpHeadersBuilder
Removes all headers. After a call to this method,size()
becomes0
.- Specified by:
clear
in interfaceHttpHeadersBuilder
- Returns:
this
-
isEndOfStream
boolean isEndOfStream()Tells whether the headers correspond to the last frame in an HTTP/2 stream. -
contentLength
long contentLength()Returns the value of the content-length header, or-1
if this value is not known. -
isContentLengthUnknown
Returns whether the content length is unknown. Iftrue
,content-length
header is not automatically updated. -
contentType
Returns the parsed"content-type"
header.- Returns:
- the parsed
MediaType
if present and valid, ornull
otherwise.
-
contentDisposition
Returns the parsed"content-disposition"
header.- Returns:
- the parsed
MediaType
if present and valid.null
if not present or failed to parse"content-disposition"
header.
-
get
Returns the value of a header with the specifiedname
. If there are more than one value for the specifiedname
, 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
Returns the value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the first value in insertion order is returned.- Parameters:
name
- the name of the header to retrievedefaultValue
- the default value- Returns:
- the first header value or
defaultValue
if there is no such header
-
getLast
Returns the value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the last value in insertion order is returned.- Parameters:
name
- the name of the header to retrieve- Returns:
- the last header value if the header is found, or
null
if there's no such header
-
getLast
Returns the value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the last value in insertion order is returned.- Parameters:
name
- the name of the header to retrievedefaultValue
- the default value- Returns:
- the last header value or
defaultValue
if there is no such header
-
getAll
Returns all values for the header with the specified name. The returnedList
can't be modified. -
getBoolean
Returns theboolean
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the first value in insertion order is returned.- Parameters:
name
- the name of the header to retrieve- Returns:
- the
boolean
value of the first value in insertion order ornull
if there is no such header or it can't be converted toboolean
.
-
getBoolean
Returns theboolean
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the first value in insertion order is returned.- Parameters:
name
- the name of the header to retrievedefaultValue
- the default value- Returns:
- the
boolean
value of the first value in insertion order ordefaultValue
if there is no such header or it can't be converted toboolean
.
-
getLastBoolean
Returns theboolean
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the last value in insertion order is returned.- Parameters:
name
- the name of the header to retrieve- Returns:
- the
boolean
value of the last value in insertion order ornull
if there is no such header or it can't be converted toboolean
.
-
getLastBoolean
Returns theboolean
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the last value in insertion order is returned.- Parameters:
name
- the name of the header to retrievedefaultValue
- the default value- Returns:
- the
boolean
value of the last value in insertion order ordefaultValue
if there is no such header or it can't be converted toboolean
.
-
getLastInt
Returns theint
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the last value in insertion order is returned.- Parameters:
name
- the name of the header to retrieve- Returns:
- the
int
value of the last value in insertion order ornull
if there is no such header or it can't be converted toint
.
-
getLastInt
Returns theint
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the last value in insertion order is returned.- Parameters:
name
- the name of the header to retrievedefaultValue
- the default value- Returns:
- the
int
value of the last value in insertion order ordefaultValue
if there is no such header or it can't be converted toint
.
-
getInt
Returns theint
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, 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 ornull
if there is no such header or it can't be converted toint
.
-
getInt
Returns theint
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the first value in insertion order is returned.- Parameters:
name
- the name of the header to retrievedefaultValue
- the default value- Returns:
- the
int
value of the first value in insertion order ordefaultValue
if there is no such header or it can't be converted toint
.
-
getLong
Returns thelong
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, 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 ornull
if there is no such header or it can't be converted tolong
.
-
getLong
Returns thelong
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the first value in insertion order is returned.- Parameters:
name
- the name of the header to retrievedefaultValue
- the default value- Returns:
- the
long
value of the first value in insertion order ordefaultValue
if there is no such header or it can't be converted tolong
.
-
getLastLong
Returns thelong
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the last value in insertion order is returned.- Parameters:
name
- the name of the header to retrieve- Returns:
- the
long
value of the last value in insertion order ornull
if there is no such header or it can't be converted tolong
.
-
getLastLong
Returns thelong
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the last value in insertion order is returned.- Parameters:
name
- the name of the header to retrievedefaultValue
- the default value- Returns:
- the
long
value of the last value in insertion order ordefaultValue
if there is no such header or it can't be converted tolong
.
-
getFloat
Returns thefloat
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, 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 ornull
if there is no such header or it can't be converted tofloat
.
-
getFloat
Returns thefloat
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the first value in insertion order is returned.- Parameters:
name
- the name of the header to retrievedefaultValue
- the default value- Returns:
- the
float
value of the first value in insertion order ordefaultValue
if there is no such header or it can't be converted tofloat
.
-
getLastFloat
Returns thefloat
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the last value in insertion order is returned.- Parameters:
name
- the name of the header to retrieve- Returns:
- the
float
value of the last value in insertion order ornull
if there is no such header or it can't be converted tofloat
.
-
getLastFloat
Returns thefloat
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the last value in insertion order is returned.- Parameters:
name
- the name of the header to retrievedefaultValue
- the default value- Returns:
- the
float
value of the last value in insertion order ordefaultValue
if there is no such header or it can't be converted tofloat
.
-
getDouble
Returns thedouble
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, 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 ornull
if there is no such header or it can't be converted todouble
.
-
getDouble
Returns thedouble
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the first value in insertion order is returned.- Parameters:
name
- the name of the header to retrievedefaultValue
- the default value- Returns:
- the
double
value of the first value in insertion order ordefaultValue
if there is no such header or it can't be converted todouble
.
-
getLastDouble
Returns thedouble
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the last value in insertion order is returned.- Parameters:
name
- the name of the header to retrieve- Returns:
- the
double
value of the last value in insertion order ornull
if there is no such header or it can't be converted todouble
.
-
getLastDouble
Returns thedouble
value of a header with the specifiedname
. If there are more than one value for the specifiedname
, the last value in insertion order is returned.- Parameters:
name
- the name of the header to retrievedefaultValue
- the default value- Returns:
- the
double
value of the last value in insertion order ordefaultValue
if there is no such header or it can't be converted todouble
.
-
getTimeMillis
Returns the value of a header with the specifiedname
in milliseconds. If there are more than one value for the specifiedname
, 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
Returns the value of a header with the specifiedname
in milliseconds. If there are more than one value for the specifiedname
, the first value in insertion order is returned.- Parameters:
name
- the name of the header to retrievedefaultValue
- 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.
-
getLastTimeMillis
Returns the value of a header with the specifiedname
in milliseconds. If there are more than one value for the specifiedname
, the last value in insertion order is returned.- Parameters:
name
- the name of the header to retrieve- Returns:
- the milliseconds value of the last value in insertion order or
null
if there is no such header or it can't be converted to milliseconds.
-
getLastTimeMillis
Returns the value of a header with the specifiedname
in milliseconds. If there are more than one value for the specifiedname
, the last value in insertion order is returned.- Parameters:
name
- the name of the header to retrievedefaultValue
- the default value- Returns:
- the milliseconds value of the last value in insertion order or
defaultValue
if there is no such header or it can't be converted to milliseconds.
-
contains
Returnstrue
if a header with thename
exists,false
otherwise.- Parameters:
name
- the header name
-
contains
Returnstrue
if a header with thename
andvalue
exists.- Parameters:
name
- the header namevalue
- the header value of the header to find
-
containsObject
Returnstrue
if a header with thename
andvalue
exists.- Parameters:
name
- the header namevalue
- the header value- Returns:
true
if the header exists.false
otherwise
-
containsBoolean
Returnstrue
if a header with thename
andvalue
exists.- Parameters:
name
- the header namevalue
- the header value- Returns:
true
if the header exists.false
otherwise
-
containsInt
Returnstrue
if a header with thename
andvalue
exists.- Parameters:
name
- the header namevalue
- the header value- Returns:
true
if the header exists.false
otherwise
-
containsLong
Returnstrue
if a header with thename
andvalue
exists.- Parameters:
name
- the header namevalue
- the header value- Returns:
true
if the header exists.false
otherwise
-
containsFloat
Returnstrue
if a header with thename
andvalue
exists.- Parameters:
name
- the header namevalue
- the header value- Returns:
true
if the header exists.false
otherwise
-
containsDouble
Returnstrue
if a header with thename
andvalue
exists.- Parameters:
name
- the header namevalue
- the header value- Returns:
true
if the header exists.false
otherwise
-
containsTimeMillis
Returnstrue
if a header with thename
andvalue
exists.- Parameters:
name
- the header namevalue
- the header value- Returns:
true
if the header exists.false
otherwise
-
size
int size()Returns the number of headers. -
isEmpty
boolean isEmpty()Returnstrue
if this headers does not contain any entries. -
names
Set<io.netty.util.AsciiString> names() -
iterator
Returns anIterator
that yields all header entries. The iteration order is as follows:- All pseudo headers (order not specified).
- All non-pseudo headers (in insertion order).
-
valueIterator
Returns anIterator
that yields all values of the headers with the specifiedname
. -
forEach
Invokes the specifiedaction
for all header entries. -
forEachValue
Invokes the specifiedaction
for all values of the headers with the specifiedname
. -
stream
Returns aStream
that yields all header entries. -
valueStream
Returns aStream
that yields all values of the headers with the specifiedname
. -
status
HttpStatus status()Returns the value of the":status"
header as anHttpStatus
. If the value is malformed,HttpStatus.UNKNOWN
will be returned.- Throws:
IllegalStateException
- if there is no such header.
-
cookies
Cookies cookies()Returns the parsed set-cookie header.
-