Result (jooby 0.8.0 API)

java.lang.Object
- org.jooby.Result

Direct Known Subclasses:

View
```
public class Result
extends Object
```
Utility class for HTTP responses. Usually you start with a result builder Results and then you customize (or not) one or more HTTP attribute.
The following examples build the same output:
```
 {
   get("/", (req, rsp)  -> {
     rsp.status(200).send("Something");
   });

   get("/", req  -> Results.with("Something", 200);
 }
 
```
A result is also responsible for content negotiation (if required):
```
 {
   get("/", ()  -> {
     Object model = ...;
     return Results.when("text/html", ()  -> Viewable.of("view", "model", model))
       .when("application/json", ()  -> model);
   });
 }
 
```
The example above will render a view when accept header is "text/html" or just send a text version of model when the accept header is "application/json".
Since:

0.5.0

Author:

edgar

See Also:

Results

Constructor Summary

Constructors
Constructor and Description

Result()

Constructors
Constructor and Description
`Result()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<Object>`	`get()`
`Optional<Object>`	`get(List<MediaType> types)` Get a result value for the given types (accept header).
`Result`	`header(String name, Iterable<Object> values)` Sets a response header with the given name and value.
`Result`	`header(String name, Object... values)` Sets a response header with the given name and value.
`Result`	`header(String name, Object value)` Sets a response header with the given name and value.
`Map<String,Object>`	`headers()`
`Result`	`set(Object content)` Set result content.
`Optional<Status>`	`status()`
`Result`	`status(int status)` Set response status.
`Result`	`status(Status status)` Set response status.
`Optional<MediaType>`	`type()`
`Result`	`type(MediaType type)` Set the content type of this content.
`Result`	`type(String type)` Set the content type of this content.
`Result`	`when(MediaType type, Supplier<Object> supplier)` Add a when clause for a custom result for the given media-type.
`Result`	`when(String type, Supplier<Object> supplier)` Add a when clause for a custom result for the given media-type.

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

- Constructor Detail
  - Result
```
public Result()
```
- Method Detail
  - status
```
public Result status(Status status)
```
    Set response status.
    
    Parameters:
    
    status - A new response status to use.
    
    Returns:
    
    This content.
  - status
```
public Result status(int status)
```
    Set response status.
    
    Parameters:
    
    status - A new response status to use.
    
    Returns:
    
    This content.
  - type
```
public Result type(MediaType type)
```
    Set the content type of this content.
    
    Parameters:
    
    type - A content type.
    
    Returns:
    
    This content.
  - type
```
public Result type(String type)
```
    Set the content type of this content.
    
    Parameters:
    
    type - A content type.
    
    Returns:
    
    This content.
  - set
```
public Result set(Object content)
```
    Set result content.
    
    Parameters:
    
    content - A result content.
    
    Returns:
    
    This content.
  - when
```
public Result when(String type,
                   Supplier<Object> supplier)
```
    Add a when clause for a custom result for the given media-type.
    
    Parameters:
    
    type - A media type to test for.
    
    supplier - An object supplier.
    
    Returns:
    
    This result.
  - when
```
public Result when(MediaType type,
                   Supplier<Object> supplier)
```
    Add a when clause for a custom result for the given media-type.
    
    Parameters:
    
    type - A media type to test for.
    
    supplier - An object supplier.
    
    Returns:
    
    This result.
  - headers
```
public Map<String,Object> headers()
```
    Returns:
    
    headers for content.
  - status
```
public Optional<Status> status()
```
    Returns:
    
    Body status.
  - type
```
public Optional<MediaType> type()
```
    Returns:
    
    Body type.
  - get
```
public Optional<Object> get()
```
  - get
```
public Optional<Object> get(List<MediaType> types)
```
    Get a result value for the given types (accept header).
    
    Parameters:
    
    types - Accept header.
    
    Returns:
    
    Result content.
  - header
```
public Result header(String name,
                     Object value)
```
    Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one.
    
    Parameters:
    
    name - Header's name.
    
    value - Header's value.
    
    Returns:
    
    This content.
  - header
```
public Result header(String name,
                     Object... values)
```
    Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one.
    
    Parameters:
    
    name - Header's name.
    
    values - Header's values.
    
    Returns:
    
    This content.
  - header
```
public Result header(String name,
                     Iterable<Object> values)
```
    Sets a response header with the given name and value. If the header had already been set, the new value overwrites the previous one.
    
    Parameters:
    
    name - Header's name.
    
    values - Header's values.
    
    Returns:
    
    This content.

Class Result

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Result

Method Detail

status

status

type

type

set

when

when

headers

status

type

get

get

header

header

header