play.mvc

Class Result

java.lang.Object

play.mvc.Result

Direct Known Subclasses:

StatusHeader

public class Result
extends java.lang.Object

Any action result.

Constructor Summary

Constructors

Constructor and Description
Result(int status) Create a result with no entity.
Result(int status, HttpEntity body) Create a result.
Result(int status, java.util.Map<java.lang.String,java.lang.String> headers) Create a result with no body.
Result(int status, java.util.Map<java.lang.String,java.lang.String> headers, HttpEntity body) Create a result.
Result(int status, java.util.Optional<java.lang.String> reasonPhrase, java.util.Map<java.lang.String,java.lang.String> headers, HttpEntity body) Deprecated. Deprecated as of 2.6.0. Use Result(int, String, Map, HttpEntity).
Result(int status, java.lang.String reasonPhrase, java.util.Map<java.lang.String,java.lang.String> headers, HttpEntity body) Create a result.
Result(ResponseHeader header, HttpEntity body) Create a result from a Scala ResponseHeader and a body.
Result(ResponseHeader header, HttpEntity body, Http.Session session, Http.Flash flash, java.util.List<Http.Cookie> cookies) Create a result from a Scala ResponseHeader and a body.

Method Summary

Modifier and Type	Method and Description
Result	as(java.lang.String contentType) Return a copy of the result with a different Content-Type header.
play.api.mvc.Result	asScala() Convert this result to a Scala result.
HttpEntity	body() Get the body of this result.
java.util.Optional<java.lang.String>	charset() Extracts the Charset of this Result value.
java.util.Optional<java.lang.String>	contentType() Extracts the Content-Type of this Result value.
Http.Cookie	cookie(java.lang.String name) Extracts a Cookie value from this Result value
Http.Cookies	cookies() Extracts the Cookies (an iterator) from this result value.
Result	discardHeader(java.lang.String name) Discard a HTTP header in this result.
Http.Flash	flash() Extracts the Flash values of this Result value.
protected ResponseHeader	getHeader() Get the response header
protected play.api.mvc.ResponseHeader	header() Deprecated. Deprecated as in 2.6.0. Use getHeader()
java.util.Optional<java.lang.String>	header(java.lang.String header) Extracts an Header value of this Result value.
java.util.Map<java.lang.String,java.lang.String>	headers() Extracts all Headers of this Result value.
java.util.Optional<java.lang.String>	reasonPhrase() Get the reason phrase, if it was set.
java.util.Optional<java.lang.String>	redirectLocation() Extracts the Location header of this Result value if this Result is a Redirect.
Http.Session	session() Extracts the Session of this Result value.
int	status() Get the status.
Result	withCookies(Http.Cookie... newCookies) Returns a copy of this result with the given cookies.
Result	withHeader(java.lang.String name, java.lang.String value) Return a copy of this result with the given header.
Result	withHeaders(java.lang.String... nameValues) Return a copy of this result with the given headers.

Methods inherited from class java.lang.Object

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

Constructor Detail

Result

public Result(ResponseHeader header,
              HttpEntity body,
              Http.Session session,
              Http.Flash flash,
              java.util.List<Http.Cookie> cookies)

Create a result from a Scala ResponseHeader and a body.

Parameters:

header - the response header

body - the response body.

session - the session set on the response.

flash - the flash object on the response.

cookies - the cookies set on the response.

Result

public Result(ResponseHeader header,
              HttpEntity body)

Create a result from a Scala ResponseHeader and a body.

Parameters:

header - the response header

body - the response body.

Result

@Deprecated
public Result(int status,
                          java.util.Optional<java.lang.String> reasonPhrase,
                          java.util.Map<java.lang.String,java.lang.String> headers,
                          HttpEntity body)

Deprecated. Deprecated as of 2.6.0. Use Result(int, String, Map, HttpEntity).

Create a result.

Parameters:

status - The status.

reasonPhrase - The reason phrase, if a non default reason phrase is required.

headers - The headers.

body - The body.

Result

public Result(int status,
              java.lang.String reasonPhrase,
              java.util.Map<java.lang.String,java.lang.String> headers,
              HttpEntity body)

Create a result.

Parameters:

status - The status.

reasonPhrase - The reason phrase, if a non default reason phrase is required.

headers - The headers.

body - The body.

Result

public Result(int status,
              java.util.Map<java.lang.String,java.lang.String> headers,
              HttpEntity body)

Create a result.

Parameters:

status - The status.

headers - The headers.

body - The body.

Result

public Result(int status,
              java.util.Map<java.lang.String,java.lang.String> headers)

Create a result with no body.

Parameters:

status - The status.

headers - The headers.

Result

public Result(int status,
              HttpEntity body)

Create a result.

Parameters:

status - The status.

body - The entity.

Result

public Result(int status)

Create a result with no entity.

Parameters:

status - The status.

Method Detail

status

public int status()

Get the status.

Returns:

the status

reasonPhrase

public java.util.Optional<java.lang.String> reasonPhrase()

Get the reason phrase, if it was set.

Returns:

the reason phrase (e.g. "NOT FOUND")

header

@Deprecated
protected play.api.mvc.ResponseHeader header()

Deprecated. Deprecated as in 2.6.0. Use getHeader()

Get the Scala version of response header

Returns:

the header

See Also:

ResponseHeader

getHeader

protected ResponseHeader getHeader()

Get the response header

Returns:

the header

body

public HttpEntity body()

Get the body of this result.

Returns:

the body

redirectLocation

public java.util.Optional<java.lang.String> redirectLocation()

Extracts the Location header of this Result value if this Result is a Redirect.

Returns:

the location (if it was set)

header

public java.util.Optional<java.lang.String> header(java.lang.String header)

Extracts an Header value of this Result value.

Parameters:

header - the header name.

Returns:

the header (if it was set)

headers

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

Extracts all Headers of this Result value. The returned map is not modifiable.

Returns:

the immutable map of headers

contentType

public java.util.Optional<java.lang.String> contentType()

Extracts the Content-Type of this Result value.

Returns:

the content type (if it was set)

charset

public java.util.Optional<java.lang.String> charset()

Extracts the Charset of this Result value.

Returns:

the charset (if it was set)

flash

public Http.Flash flash()

Extracts the Flash values of this Result value.

Returns:

the flash (if it was set)

session

public Http.Session session()

Extracts the Session of this Result value.

Returns:

the session (if it was set)

cookie

public Http.Cookie cookie(java.lang.String name)

Extracts a Cookie value from this Result value

Parameters:

name - the cookie's name.

Returns:

the cookie (if it was set)

cookies

public Http.Cookies cookies()

Extracts the Cookies (an iterator) from this result value.

Returns:

the cookies (if they were set)

withCookies

public Result withCookies(Http.Cookie... newCookies)

Returns a copy of this result with the given cookies.

Parameters:

newCookies - the cookies to add to the result.

Returns:

the transformed copy.

withHeader

public Result withHeader(java.lang.String name,
                         java.lang.String value)

Return a copy of this result with the given header.

Parameters:

name - the header name

value - the header value

Returns:

the transformed copy

withHeaders

public Result withHeaders(java.lang.String... nameValues)

Return a copy of this result with the given headers. The headers are processed in pairs, so nameValues(0) is the first header's name, and nameValues(1) is the first header's value, nameValues(2) is second header's name, and so on.

Parameters:

nameValues - the array of names and values.

Returns:

the transformed copy

discardHeader

public Result discardHeader(java.lang.String name)

Discard a HTTP header in this result.

Parameters:

name - the header name

Returns:

the transformed copy

as

public Result as(java.lang.String contentType)

Return a copy of the result with a different Content-Type header.

Parameters:

contentType - the content type to set

Returns:

the transformed copy

asScala

public play.api.mvc.Result asScala()

Convert this result to a Scala result.

Returns:

the Scala result.