org.jooby

Class Result

java.lang.Object

org.jooby.Result

Direct Known Subclasses:

Deferred, View

public class Result
extends Object

Utility class for HTTP responses. Usually you start with a result builder 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", ()  -> Results.html("view").put("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()

Method Summary

Modifier and Type	Method and Description
<T> T	get() Get a result value.
<T> T	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()
Optional<Object>	ifGet() Get a result value.
Optional<Object>	ifGet(List<MediaType> types) Get a result value for the given types (accept header).
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

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

Constructor Detail

Result

public Result()

Method Detail

status

@Nonnull
public Result status(Status status)

Set response status.

Parameters:

status - A new response status to use.

Returns:

This content.

status

@Nonnull
public Result status(int status)

Set response status.

Parameters:

status - A new response status to use.

Returns:

This content.

type

@Nonnull
public Result type(MediaType type)

Set the content type of this content.

Parameters:

type - A content type.

Returns:

This content.

type

@Nonnull
public Result type(String type)

Set the content type of this content.

Parameters:

type - A content type.

Returns:

This content.

set

@Nonnull
public Result set(Object content)

Set result content.

Parameters:

content - A result content.

Returns:

This content.

when

@Nonnull
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

@Nonnull
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

@Nonnull
public Map<String,Object> headers()

Returns:

headers for content.

status

@Nonnull
public Optional<Status> status()

Returns:

Body status.

type

@Nonnull
public Optional<MediaType> type()

Returns:

Body type.

ifGet

@Nonnull
public Optional<Object> ifGet()

Get a result value.

Returns:

Value or empty

get

@Nullable
public <T> T get()

Get a result value.

Type Parameters:

T - Value type.

Returns:

Value or null

ifGet

@Nonnull
public Optional<Object> ifGet(List<MediaType> types)

Get a result value for the given types (accept header).

Parameters:

types - Accept header.

Returns:

Result content.

get

@Nullable
public <T> T get(List<MediaType> types)

Get a result value for the given types (accept header).

Type Parameters:

T - Value type.

Parameters:

types - Accept header.

Returns:

Result content or null.

header

@Nonnull
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

@Nonnull
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

@Nonnull
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.