Result (vraptor 3.5.4 API)

All Known Implementing Classes:

AbstractResult, DefaultResult, MockHttpResult, MockResult, MockSerializationResult
```
public interface Result
```
A resource requisition result.

Author:

Guilherme Silveira

Method Summary

Methods
Modifier and Type	Method and Description
`<T> T`	`forwardTo(Class<T> controller)` A shortcut to result.use(logic()).forwardTo(controller)
`void`	`forwardTo(String uri)` A shortcut to result.use(page()).forwardTo(uri);
`<T> T`	`forwardTo(T controller)` A shortcut to result.use(logic()).forwardTo(controller.getClass()) so you can use on your controller: result.forwardTo(this).aMethod();
`Result`	`include(Object value)` Stores an attribute in the result.
`Result`	`include(String key, Object value)` Stores an attribute in the result.
`Map<String,Object>`	`included()` Return all included attributes via Result.include();
`void`	`notFound()` A shortcut to result.use(status()).notFound();
`void`	`nothing()` A shortcut to result.use(nothing())
`<T> T`	`of(Class<T> controller)` A shortcut to result.use(page()).of(controller)
`<T> T`	`of(T controller)` A shortcut to result.use(page()).of(controller.getClass()) so you can use on your controller: result.of(this).aMethod();
`Result`	`on(Class<? extends Exception> exception)` Add an `Exception` to be handled by Exception Handler.
`<T> T`	`permanentlyRedirectTo(Class<T> controller)` A shortcut to result.use(status()).movedPermanentlyTo(controller).
`void`	`permanentlyRedirectTo(String uri)` A shortcut to result.use(status()).movedPermanentlyTo(uri).
`<T> T`	`permanentlyRedirectTo(T controller)` A shortcut to result.use(status()).movedPermanentlyTo(controller.getClass()).
`<T> T`	`redirectTo(Class<T> controller)` A shortcut to result.use(logic()).redirectTo(controller)
`void`	`redirectTo(String uri)` A shortcut to result.use(page()).redirectTo(uri);
`<T> T`	`redirectTo(T controller)` A shortcut to result.use(logic()).redirectTo(controller.getClass()) so you can use on your controller: result.redirectTo(this).aMethod();
`<T extends View> T`	`use(Class<T> view)` Force result to use the defined view.
`boolean`	`used()` Whether this result was used.

- Method Detail
  - include
```
Result include(String key,
             Object value)
```
    Stores an attribute in the result.
    
    Parameters:
    key - a String specifying the key of the attribute
    value - the object to be stored
    
    Returns:
    this own class
  - include
```
Result include(Object value)
```
    Stores an attribute in the result. The key for the object is defined by extracting the value class.
    
    Parameters:
    value - the object to be stored
    
    Returns:
    this own class
    See Also:
    TypeNameExtractor
  - use
```
<T extends View> T use(Class<T> view)
```
    Force result to use the defined view.
  - on
```
Result on(Class<? extends Exception> exception)
```
    Add an Exception to be handled by Exception Handler.
    
    Parameters:
    exception - The exception to handle.
    
    Throws:
    
    A - NullPointerException if exception is null.
  - used
```
boolean used()
```
    Whether this result was used.
  - included
```
Map<String,Object> included()
```
    Return all included attributes via Result.include();
    
    Returns:
  - forwardTo
```
void forwardTo(String uri)
```
    A shortcut to result.use(page()).forwardTo(uri);
    
    See Also:
    PageResult.forwardTo(String)
  - redirectTo
```
void redirectTo(String uri)
```
    A shortcut to result.use(page()).redirectTo(uri);
    
    See Also:
    PageResult.forwardTo(String)
  - forwardTo
```
<T> T forwardTo(Class<T> controller)
```
    A shortcut to result.use(logic()).forwardTo(controller)
    
    Parameters:
    controller -
    See Also:
    LogicResult.forwardTo(Class)
  - redirectTo
```
<T> T redirectTo(Class<T> controller)
```
    A shortcut to result.use(logic()).redirectTo(controller)
    
    Parameters:
    controller -
    See Also:
    LogicResult.redirectTo(Class)
  - of
```
<T> T of(Class<T> controller)
```
    A shortcut to result.use(page()).of(controller)
    
    Parameters:
    controller -
    See Also:
    PageResult.of(Class)
  - redirectTo
```
<T> T redirectTo(T controller)
```
    A shortcut to result.use(logic()).redirectTo(controller.getClass()) so you can use on your controller:
    result.redirectTo(this).aMethod();
    
    Parameters:
    controller -
    See Also:
    LogicResult.redirectTo(Class)
  - forwardTo
```
<T> T forwardTo(T controller)
```
    A shortcut to result.use(logic()).forwardTo(controller.getClass()) so you can use on your controller:
    result.forwardTo(this).aMethod();
    
    Parameters:
    controller -
    See Also:
    LogicResult.forwardTo(Class)
  - of
```
<T> T of(T controller)
```
    A shortcut to result.use(page()).of(controller.getClass()) so you can use on your controller:
    result.of(this).aMethod();
    
    Parameters:
    controller -
    See Also:
    PageResult.of(Class)
  - nothing
```
void nothing()
```
    A shortcut to result.use(nothing())
  - notFound
```
void notFound()
```
    A shortcut to result.use(status()).notFound();
  - permanentlyRedirectTo
```
void permanentlyRedirectTo(String uri)
```
    A shortcut to result.use(status()).movedPermanentlyTo(uri).
    
    Parameters:
    uri -
    See Also:
    Status.movedPermanentlyTo(String)
  - permanentlyRedirectTo
```
<T> T permanentlyRedirectTo(Class<T> controller)
```
    A shortcut to result.use(status()).movedPermanentlyTo(controller).
    
    Parameters:
    controller -
    See Also:
    Status.movedPermanentlyTo(Class)
  - permanentlyRedirectTo
```
<T> T permanentlyRedirectTo(T controller)
```
    A shortcut to result.use(status()).movedPermanentlyTo(controller.getClass()). so you can use on your controller:
    result.permanentlyRedirectTo(this).aMethod();
    
    Parameters:
    controller -
    See Also:
    Status.movedPermanentlyTo(Class)

Interface Result

Method Summary

Method Detail

include

include

use

on

used

included

forwardTo

redirectTo

forwardTo

redirectTo

of

redirectTo

forwardTo

of

nothing

notFound

permanentlyRedirectTo

permanentlyRedirectTo

permanentlyRedirectTo