Result (ninja-core 5.3.1 API)

java.lang.Object
- ninja.Result

Direct Known Subclasses:: AsyncResult

public class Result
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`APPLICATION_JSON`
`static java.lang.String`	`APPLICATION_JSONP`
`static java.lang.String`	`APPLICATION_OCTET_STREAM`
`static java.lang.String`	`APPLICATION_XML`
`static java.lang.String`	`APPLICATON_JSON` Deprecated.
`static java.lang.String`	`APPLICATON_JSONP` Deprecated.
`static java.lang.String`	`CACHE_CONTROL`
`static java.lang.String`	`CACHE_CONTROL_DEFAULT_NOCACHE_VALUE`
`static java.lang.String`	`DATE`
`static java.lang.String`	`EXPIRES`
`static java.lang.String`	`LOCATION`
`static NoHttpBody`	`NO_HTTP_BODY`
`static int`	`SC_200_OK`
`static int`	`SC_201_CREATED`
`static int`	`SC_204_NO_CONTENT`
`static int`	`SC_300_MULTIPLE_CHOICES`
`static int`	`SC_301_MOVED_PERMANENTLY`
`static int`	`SC_302_FOUND`
`static int`	`SC_303_SEE_OTHER`
`static int`	`SC_304_NOT_MODIFIED`
`static int`	`SC_307_TEMPORARY_REDIRECT`
`static int`	`SC_400_BAD_REQUEST`
`static int`	`SC_401_UNAUTHORIZED`
`static int`	`SC_403_FORBIDDEN`
`static int`	`SC_404_NOT_FOUND`
`static int`	`SC_500_INTERNAL_SERVER_ERROR`
`static int`	`SC_501_NOT_IMPLEMENTED`
`static java.lang.String`	`TEXT_HTML`
`static java.lang.String`	`TEXT_PLAIN`
`static java.lang.String`	`WWW_AUTHENTICATE`

Constructor Summary

Constructors
Constructor and Description

Result(int statusCode)
A result.

Constructors
Constructor and Description
`Result(int statusCode)` A result.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Result`	`addCookie(Cookie cookie)`
`Result`	`addHeader(java.lang.String headerName, java.lang.String headerContent)`
`Result`	`charset(java.lang.String charset)`
`Result`	`contentType(java.lang.String contentType)` Sets the content type.
`Result`	`doNotCacheContent()` This function sets Cache-Control: no-cache, no-store Date: (current date) Expires: 1970 => it therefore effectively forces the browser and every proxy in between not to cache content.
`com.google.common.base.Optional<java.lang.String>`	`fallbackContentType()`
`Result`	`fallbackContentType(java.lang.String fallbackContentType)`
`java.lang.String`	`getCharset()`
`java.lang.String`	`getContentType()`
`Cookie`	`getCookie(java.lang.String cookieName)` Returns cookie with that name or null.
`java.util.List<Cookie>`	`getCookies()`
`java.util.Map<java.lang.String,java.lang.String>`	`getHeaders()`
`java.lang.Class<?>`	`getJsonView()`
`java.lang.Object`	`getRenderable()`
`int`	`getStatusCode()`
`java.lang.String`	`getTemplate()`
`Result`	`html()` Set the content type of this result to `TEXT_HTML`.
`Result`	`json()` Set the content type of this result to `APPLICATION_JSON`.
`Result`	`jsonp()` Set the content type of this result to `APPLICATION_JSONP`.
`Result`	`jsonView(java.lang.Class<?> jsonView)` Set the Jackson JSON View.
`Result`	`redirect(java.lang.String url)` A redirect that uses 303 see other.
`Result`	`redirectTemporary(java.lang.String url)` A redirect that uses 307 see other.
`Result`	`render(java.util.Map.Entry<java.lang.String,java.lang.Object> entry)` Handles following cases: 1) If this.renderable is null: a new HashMap is generated and this entry being added to the map.
`Result`	`render(java.util.Map<java.lang.String,java.lang.Object> mapToRender)` Replaces the object being passed by this result to the rendering engine with this map.
`Result`	`render(java.lang.Object object)` This method handles two principal cases: 1) If the this.renderable of this result is null, the object passed is simply set as renderable for this Result 2) If the this.renderable of this result is not null an new map is generated as object to render and both the former renderable and the new object added to the map.
`Result`	`render(Renderable renderable)` Sets this renderable as object to render.
`Result`	`render(java.lang.String key, java.lang.Object value)` Implicitly generates a hashmap as object being rendered and adds this key, value pair.
`Result`	`renderRaw(byte[] bytes)` This method directly renders the byte array to the output.
`Result`	`renderRaw(java.lang.String string)` Deprecated. => use text().render(string), html().render(string), json().render(string), xml().render(string), or contentType(type).render(string).
`Result`	`setContentType(java.lang.String contentType)` Deprecated.
`Result`	`status(int statusCode)` Set the status of this result.
`Result`	`supportedContentType(java.lang.String contentTypeSupportedByThisResult)` Will add a content type to the list of supported content types.
`java.util.List<java.lang.String>`	`supportedContentTypes()` Returns immutable list of supported content types by this request.
`Result`	`supportedContentTypes(java.lang.String... contentTypesSupportedByThisResult)` Will add the content types to the list of supported content types.
`Result`	`template(java.lang.String template)` Set the template to render.
`Result`	`text()` Set the content type of this result to `TEXT_PLAIN`.
`Result`	`unsetCookie(java.lang.String name)`
`Result`	`xml()` Set the content type of this result to `Result#APPLICATON_XML`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SC_200_OK
```
public static final int SC_200_OK
```
    See Also:
    
    Constant Field Values
  - SC_201_CREATED
```
public static final int SC_201_CREATED
```
    See Also:
    
    Constant Field Values
  - SC_204_NO_CONTENT
```
public static final int SC_204_NO_CONTENT
```
    See Also:
    
    Constant Field Values
  - SC_300_MULTIPLE_CHOICES
```
public static final int SC_300_MULTIPLE_CHOICES
```
    See Also:
    
    Constant Field Values
  - SC_301_MOVED_PERMANENTLY
```
public static final int SC_301_MOVED_PERMANENTLY
```
    See Also:
    
    Constant Field Values
  - SC_302_FOUND
```
public static final int SC_302_FOUND
```
    See Also:
    
    Constant Field Values
  - SC_303_SEE_OTHER
```
public static final int SC_303_SEE_OTHER
```
    See Also:
    
    Constant Field Values
  - SC_304_NOT_MODIFIED
```
public static final int SC_304_NOT_MODIFIED
```
    See Also:
    
    Constant Field Values
  - SC_307_TEMPORARY_REDIRECT
```
public static final int SC_307_TEMPORARY_REDIRECT
```
    See Also:
    
    Constant Field Values
  - SC_400_BAD_REQUEST
```
public static final int SC_400_BAD_REQUEST
```
    See Also:
    
    Constant Field Values
  - SC_401_UNAUTHORIZED
```
public static final int SC_401_UNAUTHORIZED
```
    See Also:
    
    Constant Field Values
  - SC_403_FORBIDDEN
```
public static final int SC_403_FORBIDDEN
```
    See Also:
    
    Constant Field Values
  - SC_404_NOT_FOUND
```
public static final int SC_404_NOT_FOUND
```
    See Also:
    
    Constant Field Values
  - SC_500_INTERNAL_SERVER_ERROR
```
public static final int SC_500_INTERNAL_SERVER_ERROR
```
    See Also:
    
    Constant Field Values
  - SC_501_NOT_IMPLEMENTED
```
public static final int SC_501_NOT_IMPLEMENTED
```
    See Also:
    
    Constant Field Values
  - TEXT_HTML
```
public static final java.lang.String TEXT_HTML
```
    See Also:
    
    Constant Field Values
  - TEXT_PLAIN
```
public static final java.lang.String TEXT_PLAIN
```
    See Also:
    
    Constant Field Values
  - APPLICATION_JSON
```
public static final java.lang.String APPLICATION_JSON
```
    See Also:
    
    Constant Field Values
  - APPLICATON_JSON
```
@Deprecated
public static final java.lang.String APPLICATON_JSON
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - APPLICATION_JSONP
```
public static final java.lang.String APPLICATION_JSONP
```
    See Also:
    
    Constant Field Values
  - APPLICATON_JSONP
```
@Deprecated
public static final java.lang.String APPLICATON_JSONP
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - APPLICATION_XML
```
public static final java.lang.String APPLICATION_XML
```
    See Also:
    
    Constant Field Values
  - APPLICATION_OCTET_STREAM
```
public static final java.lang.String APPLICATION_OCTET_STREAM
```
    See Also:
    
    Constant Field Values
  - NO_HTTP_BODY
```
public static final NoHttpBody NO_HTTP_BODY
```
  - LOCATION
```
public static final java.lang.String LOCATION
```
    See Also:
    
    Constant Field Values
  - CACHE_CONTROL
```
public static final java.lang.String CACHE_CONTROL
```
    See Also:
    
    Constant Field Values
  - CACHE_CONTROL_DEFAULT_NOCACHE_VALUE
```
public static final java.lang.String CACHE_CONTROL_DEFAULT_NOCACHE_VALUE
```
    See Also:
    
    Constant Field Values
  - DATE
```
public static final java.lang.String DATE
```
    See Also:
    
    Constant Field Values
  - EXPIRES
```
public static final java.lang.String EXPIRES
```
    See Also:
    
    Constant Field Values
  - WWW_AUTHENTICATE
```
public static final java.lang.String WWW_AUTHENTICATE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Result
```
public Result(int statusCode)
```
    A result. Sets utf-8 as charset and status code by default. Refer to SC_200_OK, SC_204_NO_CONTENT and so on for some short cuts to predefined results.
    
    Parameters:
    
    statusCode - The status code to set for the result. Shortcuts to the code at: SC_200_OK
- Method Detail
  - getRenderable
```
public java.lang.Object getRenderable()
```
  - render
```
public Result render(java.lang.Object object)
```
    This method handles two principal cases: 1) If the this.renderable of this result is null, the object passed is simply set as renderable for this Result 2) If the this.renderable of this result is not null an new map is generated as object to render and both the former renderable and the new object added to the map. The former object is gets the class name in camelCase as key. If the converted camelCase key of this object already exists an IllegalArgumentException is being thrown.
    
    Parameters:
    
    object - The object to add (either an arbitrary class or Renderable).
    
    Returns:
    
    Result this result for chaining.
  - render
```
public Result render(java.util.Map<java.lang.String,java.lang.Object> mapToRender)
```
    Replaces the object being passed by this result to the rendering engine with this map. It will overwrite any previously set render(...) calls.
    
    Parameters:
    
    mapToRender - The map being passed to the templating engine.
    
    Returns:
    
    This Result for chaining.
  - render
```
public Result render(java.util.Map.Entry<java.lang.String,java.lang.Object> entry)
```
    Handles following cases: 1) If this.renderable is null: a new HashMap is generated and this entry being added to the map. 2) If this.renderable is a Map: the entry is added 3) If this.renderable is an object (not a renderable): a Map is generated and both the former object and the new entry are being added. 4) If this.renderable is a Renderable: an IllegalArgumentException is thrown. If the entry key already exists in the map of this.renderable an IllegalArgumentException is thrown.
    
    Parameters:
    
    entry - The entry to add.
    
    Returns:
    
    The result for further chaining.
  - render
```
public Result render(Renderable renderable)
```
    Sets this renderable as object to render. Usually this renderable does rendering itself and will not call any templating engine.
    
    Parameters:
    
    renderable - The renderable that will handle everything after returing the result.
    
    Returns:
    
    This result for chaining.
  - render
```
public Result render(java.lang.String key,
                     java.lang.Object value)
```
    Implicitly generates a hashmap as object being rendered and adds this key, value pair. If the object being rendered is already a hashmap it simply adds this key value pair to it.
    
    Parameters:
    
    key - The key to use.
    
    value - The value to use.
    
    Returns:
    
    The Result for chaining.
  - renderRaw
```
@Deprecated
public Result renderRaw(java.lang.String string)
```
    Deprecated. => use text().render(string), html().render(string), json().render(string), xml().render(string), or contentType(type).render(string).
    
    This method directly renders the String to the output. It completely bypasses any rendering engine. Thus you can render anything you want. Chaining of resultRaw().resultRaw()... is NOT supported. Mixing with render() is NOT supported. It is always recommended to implement your own RenderingEngine OR use existing rendering engines. Example: public Result controllerMethod() { String customJson = "{\"user\" : \"john@woo.com\"}"; return Results.json().renderRaw(customJson); }
    
    Parameters:
    
    string - The string to render.
    
    Returns:
    
    A result that will render the string directly to the output stream.
  - renderRaw
```
public Result renderRaw(byte[] bytes)
```
    This method directly renders the byte array to the output. It completely bypasses any rendering engine. Thus you can render anything you want. Chaining of resultRaw().resultRaw()... is NOT supported. Mixing with render() is NOT supported. It is always recommended to implement your own RenderingEngine OR use existing rendering engines.
    
    Parameters:
    
    bytes - The bytes to render.
    
    Returns:
    
    A result that will render the string directly to the output stream.
  - getContentType
```
public java.lang.String getContentType()
```
  - getCharset
```
public java.lang.String getCharset()
```
    Returns:
    
    Charset of the current result that will be used. Will be "utf-8" by default.
  - charset
```
public Result charset(java.lang.String charset)
```
    Parameters:
    
    charset - Set the charset of the result. Is "utf-8" by default.
    
    Returns:
    
    The result for chaining.
  - setContentType
```
@Deprecated
public Result setContentType(java.lang.String contentType)
```
    Deprecated.
    
    Sets the content type
    
    Parameters:
    
    contentType -
  - contentType
```
public Result contentType(java.lang.String contentType)
```
    Sets the content type. Must not contain any charset WRONG: "text/html; charset=utf8". If you want to set the charset use method charset(String);
    
    Parameters:
    
    contentType - (without encoding) something like "text/html" or "application/json"
    
    Returns:
    
    The result for chaining.
  - supportedContentType
```
public Result supportedContentType(java.lang.String contentTypeSupportedByThisResult)
```
    Will add a content type to the list of supported content types. Calling that method two times with different content types will add both content types.
    
    Parameters:
    
    contentTypeSupportedByThisResult - The content type to add. Eg. "application/xml"
    
    Returns:
    
    The result for chaining.
  - supportedContentTypes
```
public Result supportedContentTypes(java.lang.String... contentTypesSupportedByThisResult)
```
    Will add the content types to the list of supported content types.
    
    Parameters:
    
    contentTypesSupportedByThisResult - The content type to add. Eg. "application/xml", "applcation/json"
    
    Returns:
    
    The result for chaining.
  - supportedContentTypes
```
public java.util.List<java.lang.String> supportedContentTypes()
```
    Returns immutable list of supported content types by this request.
    
    Returns:
    
    immutable list of supported content types. Either the default content types if no one has been set (html, json, xml) or the content types set by the user and supportedContentType(...).
  - fallbackContentType
```
public com.google.common.base.Optional<java.lang.String> fallbackContentType()
```
    Returns:
    
    The fallback content type. This will be the content type used when none of the supported content types matches the accept content type of the request.
  - fallbackContentType
```
public Result fallbackContentType(java.lang.String fallbackContentType)
```
    Parameters:
    
    fallbackContentType - The content type to use as fallback when neither contentType set and supportedContentTypes do not match request.
    
    Returns:
    
    This result for chaining.
  - getHeaders
```
public java.util.Map<java.lang.String,java.lang.String> getHeaders()
```
  - addHeader
```
public Result addHeader(java.lang.String headerName,
                        java.lang.String headerContent)
```
  - getCookie
```
public Cookie getCookie(java.lang.String cookieName)
```
    Returns cookie with that name or null.
    
    Parameters:
    
    cookieName - Name of the cookie
    
    Returns:
    
    The cookie or null if not found.
  - getCookies
```
public java.util.List<Cookie> getCookies()
```
  - addCookie
```
public Result addCookie(Cookie cookie)
```
  - unsetCookie
```
public Result unsetCookie(java.lang.String name)
```
  - getStatusCode
```
public int getStatusCode()
```
  - status
```
public Result status(int statusCode)
```
    Set the status of this result. Refer to SC_200_OK, SC_204_NO_CONTENT and so on for some short cuts to predefined results.
    
    Parameters:
    
    statusCode - The status code. Result (SC_200_OK) provides some helpers.
    
    Returns:
    
    The result you executed the method on for method chaining.
  - getTemplate
```
public java.lang.String getTemplate()
```
  - template
```
public Result template(java.lang.String template)
```
    Set the template to render. For instance template("views/AnotherController/anotherview.ftl.html");
    
    Parameters:
    
    template - The view to render. Eg. views/AnotherController/anotherview.ftl.html
    
    Returns:
    
    The result that you executed the method on for chaining.
  - getJsonView
```
public java.lang.Class<?> getJsonView()
```
  - jsonView
```
public Result jsonView(java.lang.Class<?> jsonView)
```
    Set the Jackson JSON View. See http://wiki.fasterxml.com/JacksonJsonViews
    
    Parameters:
    
    jsonView - JSON serialization view class to use when rendering
    
    Returns:
    
    The result that you executed the method on for chaining, with JSON view set
  - redirect
```
public Result redirect(java.lang.String url)
```
    A redirect that uses 303 see other.
    
    Parameters:
    
    url - The url used as redirect target.
    
    Returns:
    
    A nicely configured result with status code 303 and the url set as Location header.
  - redirectTemporary
```
public Result redirectTemporary(java.lang.String url)
```
    A redirect that uses 307 see other.
    
    Parameters:
    
    url - The url used as redirect target.
    
    Returns:
    
    A nicely configured result with status code 307 and the url set as Location header.
  - html
```
public Result html()
```
    Set the content type of this result to TEXT_HTML.
    
    Returns:
    
    the same result where you executed this method on. But the content type is now TEXT_HTML.
  - json
```
public Result json()
```
    Set the content type of this result to APPLICATION_JSON.
    
    Returns:
    
    the same result where you executed this method on. But the content type is now APPLICATION_JSON.
  - jsonp
```
public Result jsonp()
```
    Set the content type of this result to APPLICATION_JSONP.
    
    Returns:
    
    the same result where you executed this method on. But the content type is now APPLICATION_JSONP.
  - text
```
public Result text()
```
    Set the content type of this result to TEXT_PLAIN.
    
    Returns:
    
    the same result where you executed this method on. But the content type is now TEXT_PLAIN.
  - xml
```
public Result xml()
```
    Set the content type of this result to Result#APPLICATON_XML.
    
    Returns:
    
    the same result where you executed this method on. But the content type is now Result#APPLICATON_XML.
  - doNotCacheContent
```
public Result doNotCacheContent()
```
    This function sets Cache-Control: no-cache, no-store Date: (current date) Expires: 1970 => it therefore effectively forces the browser and every proxy in between not to cache content. See also https://devcenter.heroku.com/articles/increasing-application-performance-with-http-cache-headers
    
    Returns:
    
    this result for chaining.

Class Result

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SC_200_OK

SC_201_CREATED

SC_204_NO_CONTENT

SC_300_MULTIPLE_CHOICES

SC_301_MOVED_PERMANENTLY

SC_302_FOUND

SC_303_SEE_OTHER

SC_304_NOT_MODIFIED

SC_307_TEMPORARY_REDIRECT

SC_400_BAD_REQUEST

SC_401_UNAUTHORIZED

SC_403_FORBIDDEN

SC_404_NOT_FOUND

SC_500_INTERNAL_SERVER_ERROR

SC_501_NOT_IMPLEMENTED

TEXT_HTML

TEXT_PLAIN

APPLICATION_JSON

APPLICATON_JSON

APPLICATION_JSONP

APPLICATON_JSONP

APPLICATION_XML

APPLICATION_OCTET_STREAM

NO_HTTP_BODY

LOCATION

CACHE_CONTROL

CACHE_CONTROL_DEFAULT_NOCACHE_VALUE

DATE

EXPIRES

WWW_AUTHENTICATE

Constructor Detail

Result

Method Detail

getRenderable

render

render

render

render

render

renderRaw

renderRaw

getContentType

getCharset

charset

setContentType

contentType

supportedContentType

supportedContentTypes

supportedContentTypes

fallbackContentType

fallbackContentType

getHeaders

addHeader

getCookie

getCookies

addCookie

unsetCookie

getStatusCode

status

getTemplate

template

getJsonView

jsonView

redirect

redirectTemporary

html

json

jsonp

text

xml

doNotCacheContent