Router.Result (rut 1.0 API)

java.lang.Object
- io.norberg.rut.Router.Result<T>

Type Parameters:

T - The router endpoint type.

Enclosing class:

Router<T>
```
public static class Router.Result<T>
extends Object
```
Routing result holder.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Collection<String>`	`allowedMethods()` Get all allowed methods for the route if `status()` is `Router.Status.SUCCESS` or `Router.Status.METHOD_NOT_ALLOWED`.
`static <T> Router.Result<T>`	`capturing(int captures)` Create a new `Router.Result` with enough capacity to hold `captures` captured parameters.
`boolean`	`isSuccess()` Convenience method for checking if the routing status is `Router.Status.SUCCESS`.
`String`	`paramName(int i)` Get the name of the captured path parameter at index {code i}.
`int`	`params()` Get the number of captured parameter values.
`ParameterType`	`paramType(int i)` Get the parameter type of the captured path parameter at index `i`.
`CharSequence`	`paramValue(int i)` Get the value of the captured path parameter at index {code i}.
`CharSequence`	`paramValueDecoded(int i)` Get the URL decoded value of the captured path parameter at index {code i}.
`int`	`paramValueEnd(int i)` Get end offset into the routed path of the captured parameter at index {code i}.
`int`	`paramValueStart(int i)` Get start offset into the routed path of the captured parameter at index {code i}.
`CharSequence`	`query()` Get query string.
`int`	`queryEnd()` Get query string end index.
`int`	`queryStart()` Get query string start index.
`Router.Status`	`status()` Get routing status of the `Router.route(java.lang.CharSequence, java.lang.CharSequence, io.norberg.rut.Router.Result<T>)` invocation.
`T`	`target()` Get routing target, if successful.

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

- Method Detail
  - capturing
```
public static <T> Router.Result<T> capturing(int captures)
```
    Create a new Router.Result with enough capacity to hold captures captured parameters.
  - status
```
public Router.Status status()
```
    Get routing status of the Router.route(java.lang.CharSequence, java.lang.CharSequence, io.norberg.rut.Router.Result<T>) invocation.
  - isSuccess
```
public boolean isSuccess()
```
    Convenience method for checking if the routing status is Router.Status.SUCCESS.
  - target
```
public T target()
```
    Get routing target, if successful.
  - params
```
public int params()
```
    Get the number of captured parameter values.
  - paramName
```
public String paramName(int i)
```
    Get the name of the captured path parameter at index {code i}.
  - paramValue
```
public CharSequence paramValue(int i)
```
    Get the value of the captured path parameter at index {code i}.
  - paramValueDecoded
```
public CharSequence paramValueDecoded(int i)
```
    Get the URL decoded value of the captured path parameter at index {code i}.
    
    Returns:
    
    The decoded value or null if the encoding is invalid.
  - paramType
```
public ParameterType paramType(int i)
```
    Get the parameter type of the captured path parameter at index i.
  - paramValueStart
```
public int paramValueStart(int i)
```
    Get start offset into the routed path of the captured parameter at index {code i}.
    
    See Also:
    
    paramValue(int), paramValueEnd(int)
  - paramValueEnd
```
public int paramValueEnd(int i)
```
    Get end offset into the routed path of the captured parameter at index {code i}.
    
    See Also:
    
    paramValue(int), paramValueStart(int)
  - queryStart
```
public int queryStart()
```
    Get query string start index. -1 if there is no query string part.
  - queryEnd
```
public int queryEnd()
```
    Get query string end index. -1 if there is no query string part.
  - query
```
public CharSequence query()
```
    Get query string. null if there is no query string part.
  - allowedMethods
```
public Collection<String> allowedMethods()
```
    Get all allowed methods for the route if status() is Router.Status.SUCCESS or Router.Status.METHOD_NOT_ALLOWED. Returns an empty collection if status() is Router.Status.NOT_FOUND.

Class Router.Result<T>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

capturing

status

isSuccess

target

params

paramName

paramValue

paramValueDecoded

paramType

paramValueStart

paramValueEnd

queryStart

queryEnd

query

allowedMethods