ej.hoka.http

Class Route

java.lang.Object

ej.hoka.http.Route

public class Route
extends Object

Represent an HTTP route.

Constructor Summary

Constructors

Constructor and Description
Route(int httpMethod, String path, RequestHandler handler) Constructs a new instance of Route.
Route(int httpMethod, String path, String acceptType, RequestHandler handler) Constructs a new instance of Route.

Method Summary

Modifier and Type	Method and Description
boolean	acceptAllContentTypes() Checks if this route accepts all content types.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
String	getAcceptType() Gets the acceptType.
RequestHandler	getHandler() Gets the request handler associated with this route.
int	getHttpMethod() Gets the integer value associated with the HTTP method of the route.
String	getHttpMethodAsString() Returns the HTTP method of this route as a String.
String	getPath() Gets the path (URI) mapped in this route.
int	hashCode() Returns a hash code value for the object.

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Route

public Route(int httpMethod,
             String path,
             RequestHandler handler)

Constructs a new instance of Route.

Parameters:

httpMethod - HTTP method HttpRequest.GET HttpRequest.POST HttpRequest.DELETE HttpRequest.PUT

path - request path

handler - request handler

Route

public Route(int httpMethod,
             String path,
             @Nullable
             String acceptType,
             RequestHandler handler)

Constructs a new instance of Route.

Parameters:

httpMethod - HTTP method HttpRequest.GET HttpRequest.POST HttpRequest.DELETE HttpRequest.PUT

path - request path

acceptType - accepted content type

handler - request handler

Method Detail

acceptAllContentTypes

public boolean acceptAllContentTypes()

Checks if this route accepts all content types.

Returns:

true if this route accepts all content types.

equals

public boolean equals(@Nullable
                      Object obj)

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap

getAcceptType

@Nullable
public String getAcceptType()

Gets the acceptType.

Returns:

the acceptType.

getHandler

public RequestHandler getHandler()

Gets the request handler associated with this route.

Returns:

the request handler associated with this route.

getHttpMethod

public int getHttpMethod()

Gets the integer value associated with the HTTP method of the route.

Returns:

http method. The mapping between the method number and the name can be found in HttpRequest.GET HttpRequest.POST HttpRequest.PUT HttpRequest.DELETE getHttpMethodAsString() can be used to get the string representation of the http method.

getHttpMethodAsString

public String getHttpMethodAsString()

Returns the HTTP method of this route as a String.

Returns:

http method as string

getPath

public String getPath()

Gets the path (URI) mapped in this route.

Returns:

the path (URI) mapped in this route.

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)