play.mvc

Class Http.Headers

java.lang.Object

play.mvc.Http.Headers

Enclosing class:

Http

public static class Http.Headers
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Headers(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

Method Summary

Modifier and Type	Method and Description
Http.Headers	addHeader(java.lang.String name, java.util.List<java.lang.String> values) Deprecated. Deprecated as of 2.8.0. Use adding(String, List) instead.
Http.Headers	addHeader(java.lang.String name, java.lang.String value) Deprecated. Deprecated as of 2.8.0. Use adding(String, String) instead.
Http.Headers	adding(java.lang.String name, java.util.List<java.lang.String> values) Add a new header with the given values.
Http.Headers	adding(java.lang.String name, java.lang.String value) Add a new header with the given value.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	asMap()
play.api.mvc.Headers	asScala()
boolean	contains(java.lang.String headerName) Checks if the given header is present.
java.util.Optional<java.lang.String>	get(java.lang.String name) Gets the header value.
java.util.List<java.lang.String>	getAll(java.lang.String name) Get all the values associated with the header name.
Http.Headers	remove(java.lang.String name) Deprecated. Deprecated as of 2.8.0. Use removing(String) instead.
Http.Headers	removing(java.lang.String name) Remove a header.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	toMap() Deprecated. Deprecated as of 2.8.0. Use asMap() instead.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Headers

public Headers(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

Method Detail

toMap

@Deprecated
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> toMap()

Deprecated. Deprecated as of 2.8.0. Use asMap() instead.

Returns:

all the headers as a map.

asMap

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> asMap()

Returns:

all the headers as an unmodifiable map.

contains

public boolean contains(java.lang.String headerName)

Checks if the given header is present.

Parameters:

headerName - The name of the header (case-insensitive)

Returns:

true if the request did contain the header.

get

public java.util.Optional<java.lang.String> get(java.lang.String name)

Gets the header value. If more than one value is associated with this header, then returns the first one.

Parameters:

name - the header name

Returns:

the first header value or empty if no value available.

getAll

public java.util.List<java.lang.String> getAll(java.lang.String name)

Get all the values associated with the header name.

Parameters:

name - the header name.

Returns:

the list of values associates with the header of empty.

asScala

public play.api.mvc.Headers asScala()

Returns:

the scala version of this headers.

addHeader

@Deprecated
public Http.Headers addHeader(java.lang.String name,
                                          java.lang.String value)

Deprecated. Deprecated as of 2.8.0. Use adding(String, String) instead.

Add a new header with the given value.

Parameters:

name - the header name

value - the header value

Returns:

this with the new header added

adding

public Http.Headers adding(java.lang.String name,
                           java.lang.String value)

Add a new header with the given value.

Parameters:

name - the header name

value - the header value

Returns:

a new Header instance with the new header added

addHeader

@Deprecated
public Http.Headers addHeader(java.lang.String name,
                                          java.util.List<java.lang.String> values)

Deprecated. Deprecated as of 2.8.0. Use adding(String, List) instead.

Add a new header with the given values.

Parameters:

name - the header name

values - the header values

Returns:

this with the new header added

adding

public Http.Headers adding(java.lang.String name,
                           java.util.List<java.lang.String> values)

Add a new header with the given values.

Parameters:

name - the header name

values - the header values

Returns:

a new Header instance with the new header added

remove

@Deprecated
public Http.Headers remove(java.lang.String name)

Deprecated. Deprecated as of 2.8.0. Use removing(String) instead.

Remove a header.

Parameters:

name - the header name.

Returns:

this without the removed header.

removing

public Http.Headers removing(java.lang.String name)

Remove a header.

Parameters:

name - the header name.

Returns:

a new Header instance without the removed header.