water.api

Class Route

java.lang.Object

water.Iced

water.api.Route

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable

public final class Route
extends Iced

Routing of an http request to a handler method, with path parameter parsing.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	_api_name
Handler	_handler
java.lang.Class<? extends Handler>	_handler_class
java.lang.reflect.Method	_handler_method
java.lang.String	_http_method
java.lang.String[]	_path_params
java.lang.String	_summary
java.lang.String	_url

Constructor Summary

Constructors

Constructor and Description
Route()
Route(RequestUri uri, java.lang.String api_name, java.lang.String summary, java.lang.Class<? extends Handler> handler_class, java.lang.String handler_method, HandlerFactory handler_factory)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
RequestUri	getUri()
int	getVersion()
int	hashCode()
java.lang.StringBuffer	markdown(Schema sinput, Schema soutput) Generate Markdown documentation for this Route.
java.lang.String	toString()

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_http_method

public java.lang.String _http_method

_url

public java.lang.String _url

_summary

public java.lang.String _summary

_api_name

public java.lang.String _api_name

_handler_class

public java.lang.Class<? extends Handler> _handler_class

_handler_method

public java.lang.reflect.Method _handler_method

_path_params

public java.lang.String[] _path_params

_handler

public Handler _handler

Constructor Detail

Route

public Route()

Route

public Route(RequestUri uri,
     java.lang.String api_name,
     java.lang.String summary,
     java.lang.Class<? extends Handler> handler_class,
     java.lang.String handler_method,
     HandlerFactory handler_factory)

Method Detail

getUri

public RequestUri getUri()

getVersion

public int getVersion()

markdown

public java.lang.StringBuffer markdown(Schema sinput,
                              Schema soutput)

Generate Markdown documentation for this Route.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object