org.jooby.apitool

Class RouteParameter

java.lang.Object

org.jooby.apitool.RouteParameter

public class RouteParameter
extends Object

Metadata and runtime information of a HTTP parameter.

Since:

1.2.0

Author:

edgar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RouteParameter.Kind Parameter Kind.
static interface	RouteParameter.Visitor<T> Provides visit methods base on parameter kind.

Constructor Summary

Constructors

Constructor and Description
RouteParameter(String name, RouteParameter.Kind kind, Type type, Object value) Creates a new RouteParameter.

Method Summary

Modifier and Type	Method and Description
<T> T	accept(RouteParameter.Visitor<T> visitor) Apply a RouteParameter.Visitor and returns the computed result.
Object	defaultValue() Default value.
RouteParameter	defaultValue(Object value) Set default value.
Optional<String>	description() Parameter description (if any).
RouteParameter	description(String description) Set parameter description.
List<String>	enums() List of enum values when the type() represents an enum.
RouteParameter.Kind	kind() Parameter kind.
RouteParameter	kind(RouteParameter.Kind kind) Set parameter kind.
String	name() Parameter name.
RouteParameter	name(String name) Set parameter name.
boolean	optional() True if parameter is optional.
String	toString()
Type	type() Parameter type.
RouteParameter	type(Type type) Set parameter type.

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteParameter

public RouteParameter(String name,
                      RouteParameter.Kind kind,
                      Type type,
                      Object value)

Creates a new RouteParameter.

Parameters:

name - Name.

kind - Kind.

type - Type.

value - Default value.

Method Detail

accept

public <T> T accept(RouteParameter.Visitor<T> visitor)

Apply a RouteParameter.Visitor and returns the computed result.

Type Parameters:

T - Result type.

Parameters:

visitor - Visitor.

Returns:

Computed result.

name

public String name()

Parameter name.

Returns:

Parameter name.

name

public RouteParameter name(String name)

Set parameter name.

Parameters:

name - Parameter name.

Returns:

This parameter.

type

public Type type()

Parameter type.

Returns:

Parameter type.

type

public RouteParameter type(Type type)

Set parameter type.

Parameters:

type - Parameter type.

Returns:

This parameter.

enums

public List<String> enums()

List of enum values when the type() represents an enum.

Returns:

Enum values.

defaultValue

public Object defaultValue()

Default value.

Returns:

Default Value.

defaultValue

public RouteParameter defaultValue(Object value)

Set default value.

Parameters:

value - Default value.

Returns:

This parameter.

kind

public RouteParameter.Kind kind()

Parameter kind.

Returns:

Parameter kind.

kind

public RouteParameter kind(RouteParameter.Kind kind)

Set parameter kind.

Parameters:

kind - Parameter kind.

Returns:

This parameter.

description

public Optional<String> description()

Parameter description (if any).

Returns:

Parameter description (if any).

description

public RouteParameter description(String description)

Set parameter description.

Parameters:

description - Parameter description.

Returns:

This parameter.

optional

public boolean optional()

True if parameter is optional. A parameter is optional when there is a default value or type() is Optional.

Returns:

True if parameter is optional. A parameter is optional when there is a default value or type() is Optional.

toString

public String toString()

Overrides:

toString in class Object