Headers (mu-server 0.56.5 API)

All Superinterfaces:: Iterable<Map.Entry<String,String>>

public interface Headers
extends Iterable<Map.Entry<String,String>>

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`List<ParameterizedHeaderWithValue>`	`accept()` Gets the `Accept-Charset` header value.
`List<ParameterizedHeaderWithValue>`	`acceptCharset()` Gets the `Accept` header value.
`List<ParameterizedHeaderWithValue>`	`acceptEncoding()` Gets the `Accept-Encoding` header value.
`List<ParameterizedHeaderWithValue>`	`acceptLanguage()` Gets the `Accept-Language` header value.
`Headers`	`add(CharSequence name, Iterable<?> values)`
`Headers`	`add(CharSequence name, Object value)`
`Headers`	`add(Headers headers)`
`Headers`	`add(String name, Iterable<?> values)`
`Headers`	`add(String name, Object value)`
`Headers`	`addInt(CharSequence name, int value)`
`Headers`	`addShort(CharSequence name, short value)` Deprecated.
`ParameterizedHeader`	`cacheControl()` Gets the `Cache-Control` header value.
`Headers`	`clear()`
`boolean`	`contains(CharSequence name)` Returns true if the given parameter is specified with any value
`boolean`	`contains(CharSequence name, CharSequence value, boolean ignoreCase)` Checks if a header with the given name exists with the given value.
`boolean`	`contains(String name)` Returns true if the given parameter is specified with any value
`boolean`	`contains(String name, String value, boolean ignoreCase)` Checks if a header with the given name exists with the given value.
`boolean`	`containsValue(CharSequence name, CharSequence value, boolean ignoreCase)` Similar to `contains(String, String, boolean)` but returns true even if a value occurs in a comma-separated header list.
`javax.ws.rs.core.MediaType`	`contentType()` Gets the parsed `Content-Type` header value.
`List<Map.Entry<String,String>>`	`entries()`
`boolean`	`equals(Object o)`
`List<ForwardedHeader>`	`forwarded()` Gets the `Forwarded` header value.
`String`	`get(CharSequence name)` Gets the value with the given name, or null if there is no parameter with that name.
`String`	`get(CharSequence name, String defaultValue)` Gets the value with the given name, or the default value if there is no parameter with that name.
`String`	`get(String name)` Gets the value with the given name, or null if there is no parameter with that name.
`List<String>`	`getAll(CharSequence name)` Gets all the parameters with the given name, or an empty list if none are found.
`List<String>`	`getAll(String name)` Gets all the parameters with the given name, or an empty list if none are found.
`List<String>`	`getAllAsString(CharSequence name)` Deprecated.
`String`	`getAsString(CharSequence name)` Deprecated.
`boolean`	`getBoolean(String name)` Gets a parameter as a boolean, where values such as `true`, `on` and `yes` as considered true, and other values (or no parameter with the name) is considered false.
`double`	`getDouble(String name, double defaultValue)` Gets the parameter as a double, or returns the default value if it was not specified or was in an invalid format.
`float`	`getFloat(String name, float defaultValue)` Gets the parameter as a float, or returns the default value if it was not specified or was in an invalid format.
`Integer`	`getInt(CharSequence name)` Deprecated.
`int`	`getInt(CharSequence name, int defaultValue)` Gets the parameter as an integer, or returns the default value if it was not specified or was in an invalid format.
`long`	`getLong(String name, long defaultValue)` Gets the parameter as a long, or returns the default value if it was not specified or was in an invalid format.
`Short`	`getShort(CharSequence name)` Deprecated.
`short`	`getShort(CharSequence name, short defaultValue)` Deprecated.
`Long`	`getTimeMillis(CharSequence name)`
`long`	`getTimeMillis(CharSequence name, long defaultValue)`
`boolean`	`hasBody()` Returns true if the headers suggest there is a message body by checking if there is a `HeaderNames.TRANSFER_ENCODING` header or the `HeaderNames.CONTENT_LENGTH` is greater than 0.
`int`	`hashCode()`
`static Headers`	`http1Headers()` Creates new headers for HTTP1 requests
`static Headers`	`http2Headers()` Creates new headers for HTTP2 requests
`boolean`	`isEmpty()`
`Iterator<Map.Entry<String,String>>`	`iterator()`
`Iterator<Map.Entry<String,String>>`	`iteratorAsString()` Deprecated.
`Set<String>`	`names()`
`Headers`	`remove(CharSequence name)`
`Headers`	`remove(String name)`
`Headers`	`set(CharSequence name, Iterable<?> values)`
`Headers`	`set(CharSequence name, Object value)`
`Headers`	`set(Headers headers)`
`Headers`	`set(String name, Iterable<?> values)`
`Headers`	`set(String name, Object value)`
`Headers`	`setAll(Headers headers)`
`Headers`	`setInt(CharSequence name, int value)`
`Headers`	`setShort(CharSequence name, short value)` Deprecated.
`int`	`size()`
`String`	`toString()`

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

- Method Detail
  - get
```
String get(String name)
```
    Gets the value with the given name, or null if there is no parameter with that name.
    
    If there are multiple parameters with the same name, the first one is returned.
    
    Parameters:
    
    name - The name of the parameter to get
    
    Returns:
    
    The value, or null
  - get
```
String get(CharSequence name)
```
    Gets the value with the given name, or null if there is no parameter with that name.
    
    If there are multiple parameters with the same name, the first one is returned.
    
    Parameters:
    
    name - The name of the parameter to get
    
    Returns:
    
    The value, or null
  - get
```
String get(CharSequence name,
           String defaultValue)
```
    Gets the value with the given name, or the default value if there is no parameter with that name.
    
    If there are multiple parameters with the same name, the first one is returned.
    
    Parameters:
    
    name - The name of the parameter to get
    
    defaultValue - The default value to use if there is no given value
    
    Returns:
    
    The value of the parameter, or the default value
  - getInt
```
@Deprecated
Integer getInt(CharSequence name)
```
    Deprecated.
  - getInt
```
int getInt(CharSequence name,
           int defaultValue)
```
    Gets the parameter as an integer, or returns the default value if it was not specified or was in an invalid format.
    
    Parameters:
    
    name - The name of the parameter.
    
    defaultValue - The value to use if none was specified, or an invalid format was used.
    
    Returns:
    
    Returns the parameter value as an integer.
  - getLong
```
long getLong(String name,
             long defaultValue)
```
    Gets the parameter as a long, or returns the default value if it was not specified or was in an invalid format.
    
    Parameters:
    
    name - The name of the parameter.
    
    defaultValue - The value to use if none was specified, or an invalid format was used.
    
    Returns:
    
    Returns the parameter value as a long.
  - getFloat
```
float getFloat(String name,
               float defaultValue)
```
    Gets the parameter as a float, or returns the default value if it was not specified or was in an invalid format.
    
    Parameters:
    
    name - The name of the parameter.
    
    defaultValue - The value to use if none was specified, or an invalid format was used.
    
    Returns:
    
    Returns the parameter value as a float.
  - getDouble
```
double getDouble(String name,
                 double defaultValue)
```
    Gets the parameter as a double, or returns the default value if it was not specified or was in an invalid format.
    
    Parameters:
    
    name - The name of the parameter.
    
    defaultValue - The value to use if none was specified, or an invalid format was used.
    
    Returns:
    
    Returns the parameter value as a double.
  - getBoolean
```
boolean getBoolean(String name)
```
    Gets a parameter as a boolean, where values such as true, on and yes as considered true, and other values (or no parameter with the name) is considered false.
    
    This can be used to access checkbox values as booleans.
    
    Parameters:
    
    name - The name of the parameter.
    
    Returns:
    
    Returns true if the value was truthy, or false if it was falsy or not specified.
  - getShort
```
@Deprecated
Short getShort(CharSequence name)
```
    Deprecated.
  - getShort
```
@Deprecated
short getShort(CharSequence name,
                            short defaultValue)
```
    Deprecated.
  - getTimeMillis
```
Long getTimeMillis(CharSequence name)
```
  - getTimeMillis
```
long getTimeMillis(CharSequence name,
                   long defaultValue)
```
  - getAll
```
List<String> getAll(String name)
```
    Gets all the parameters with the given name, or an empty list if none are found.
    
    Parameters:
    
    name - The parameter name to get
    
    Returns:
    
    All values of the parameter with the given name
  - getAll
```
List<String> getAll(CharSequence name)
```
    Gets all the parameters with the given name, or an empty list if none are found.
    
    Parameters:
    
    name - The parameter name to get
    
    Returns:
    
    All values of the parameter with the given name
  - entries
```
List<Map.Entry<String,String>> entries()
```
  - contains
```
boolean contains(String name)
```
    Returns true if the given parameter is specified with any value
    
    Parameters:
    
    name - The name of the value
    
    Returns:
    
    True if it's specified; otherwise false.
  - contains
```
boolean contains(CharSequence name)
```
    Returns true if the given parameter is specified with any value
    
    Parameters:
    
    name - The name of the value
    
    Returns:
    
    True if it's specified; otherwise false.
  - iterator
```
Iterator<Map.Entry<String,String>> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Map.Entry<String,String>>
  - isEmpty
```
boolean isEmpty()
```
  - size
```
int size()
```
    Returns:
    
    The number of headers. Repeated headers are counted twice.
  - names
```
Set<String> names()
```
  - add
```
Headers add(String name,
            Object value)
```
  - add
```
Headers add(CharSequence name,
            Object value)
```
  - add
```
Headers add(String name,
            Iterable<?> values)
```
  - add
```
Headers add(CharSequence name,
            Iterable<?> values)
```
  - add
```
Headers add(Headers headers)
```
  - addInt
```
Headers addInt(CharSequence name,
               int value)
```
  - addShort
```
@Deprecated
Headers addShort(CharSequence name,
                              short value)
```
    Deprecated.
  - set
```
Headers set(String name,
            Object value)
```
  - set
```
Headers set(CharSequence name,
            Object value)
```
  - set
```
Headers set(String name,
            Iterable<?> values)
```
  - set
```
Headers set(CharSequence name,
            Iterable<?> values)
```
  - set
```
Headers set(Headers headers)
```
  - setAll
```
Headers setAll(Headers headers)
```
  - setInt
```
Headers setInt(CharSequence name,
               int value)
```
  - setShort
```
@Deprecated
Headers setShort(CharSequence name,
                              short value)
```
    Deprecated.
  - remove
```
Headers remove(String name)
```
  - remove
```
Headers remove(CharSequence name)
```
  - clear
```
Headers clear()
```
  - contains
```
boolean contains(String name,
                 String value,
                 boolean ignoreCase)
```
    Checks if a header with the given name exists with the given value.
    
    Parameters:
    
    name - The case-insensitive header name to check.
    
    value - The value to check for.
    
    ignoreCase - If true, the case of the value is ignored.
    
    Returns:
    
    True if a header name with the given value exists.
  - contains
```
boolean contains(CharSequence name,
                 CharSequence value,
                 boolean ignoreCase)
```
    Checks if a header with the given name exists with the given value.
    
    Parameters:
    
    name - The case-insensitive header name to check.
    
    value - The value to check for.
    
    ignoreCase - If true, the case of the value is ignored.
    
    Returns:
    
    True if a header name with the given value exists.
  - containsValue
```
boolean containsValue(CharSequence name,
                      CharSequence value,
                      boolean ignoreCase)
```
    Similar to contains(String, String, boolean) but returns true even if a value occurs in a comma-separated header list.
    
    Parameters:
    
    name - The case-insensitive header name to check.
    
    value - The value to check for.
    
    ignoreCase - If true, the case of the value is ignored.
    
    Returns:
    
    True if a header name with the given value exists.
  - getAsString
```
@Deprecated
String getAsString(CharSequence name)
```
    Deprecated.
  - getAllAsString
```
@Deprecated
List<String> getAllAsString(CharSequence name)
```
    Deprecated.
  - iteratorAsString
```
@Deprecated
Iterator<Map.Entry<String,String>> iteratorAsString()
```
    Deprecated.
  - equals
```
boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
String toString()
```
    Overrides:
    
    toString in class Object
  - hasBody
```
boolean hasBody()
```
    Returns true if the headers suggest there is a message body by checking if there is a HeaderNames.TRANSFER_ENCODING header or the HeaderNames.CONTENT_LENGTH is greater than 0.
    
    Returns:
    
    True if there should be a body; otherwise false;
  - accept
```
List<ParameterizedHeaderWithValue> accept()
```
    Gets the Accept-Charset header value.
    
    For example, if a client sends text/html,application/xml;q=0.9 then this would return a list of two values: text/html, and application/xml where application/xml has a parameter q of value 0.9
    
    Returns:
    
    Returns a parsed Accept header, or an empty list if none specified.
  - acceptCharset
```
List<ParameterizedHeaderWithValue> acceptCharset()
```
    Gets the Accept header value.
    
    For example, if a client sends iso-8859-5, unicode-1-1;q=0.8 then this would return a list of two values: iso-8859-5, and unicode-1-1 where unicode-1-1 has a parameter q of value 0.8
    
    Returns:
    
    Returns a parsed Accept-Charset header, or an empty list if none specified.
  - acceptEncoding
```
List<ParameterizedHeaderWithValue> acceptEncoding()
```
    Gets the Accept-Encoding header value.
    
    For example, if a client sends gzip, deflate then this would return a list of two values: gzip and deflate
    
    Returns:
    
    Returns a parsed Accept-Encoding header, or an empty list if none specified.
  - forwarded
```
List<ForwardedHeader> forwarded()
```
    Gets the Forwarded header value.
    
    For example, if a client sends for=192.0.2.60;proto=http;by=203.0.113.43 then this would return a list of length one that has for, proto, and by values.
    
    If there is no Forwarded header, however there are X-Forwarded-* headers, then those will be used to generate pseudo-forwarded headers.
    
    Returns:
    
    Returns a parsed Forwarded header, or an empty list if none specified.
  - acceptLanguage
```
List<ParameterizedHeaderWithValue> acceptLanguage()
```
    Gets the Accept-Language header value.
    
    For example, if a client sends en-US,en;q=0.5 then this would return a list of two values: en-US and en where en has a q value of 0.5
    
    Returns:
    
    Returns a parsed Accept-Language header, or an empty list if none specified.
  - cacheControl
```
ParameterizedHeader cacheControl()
```
    Gets the Cache-Control header value.
    
    Returns:
    
    A map of cache control directives to their optional values. If no cache-control is in the header, then the resulting map will be empty.
  - contentType
```
javax.ws.rs.core.MediaType contentType()
```
    Gets the parsed Content-Type header value.
    
    Returns:
    
    The media type of the content specified by the headers, or null if not set.
  - http1Headers
```
static Headers http1Headers()
```
    Creates new headers for HTTP1 requests
    
    Returns:
    
    An empty headers object.
  - http2Headers
```
static Headers http2Headers()
```
    Creates new headers for HTTP2 requests
    
    Returns:
    
    An empty headers object.

Interface Headers

Method Summary

Methods inherited from interface java.lang.Iterable

Method Detail

get

get

get

getInt

getInt

getLong

getFloat

getDouble

getBoolean

getShort

getShort

getTimeMillis

getTimeMillis

getAll

getAll

entries

contains

contains

iterator

isEmpty

size

names

add

add

add

add

add

addInt

addShort

set

set

set

set

set

setAll

setInt

setShort

remove

remove

clear

contains

contains

containsValue

getAsString

getAllAsString

iteratorAsString

equals

hashCode

toString

hasBody

accept

acceptCharset

acceptEncoding

forwarded

acceptLanguage

cacheControl

contentType

http1Headers

http2Headers