Package com.linecorp.armeria.server

Class RoutingResult

java.lang.Object

com.linecorp.armeria.server.RoutingResult

public final class RoutingResult
extends Object

The result returned by Route.apply(RoutingContext, boolean).

Method Summary

Modifier and Type	Method	Description
static RoutingResultBuilder	builder()	Returns a new builder.
String	decodedPath()	Returns the path mapped by the Route, decoded in UTF-8.
static RoutingResult	empty()	The empty RoutingResult whose type() is RoutingResultType.NOT_MATCHED and isPresent() returns false.
static RoutingResult	excluded()	The empty RoutingResult whose type() is RoutingResultType.NOT_MATCHED and isPresent() returns false.
boolean	hasHighestScore()	Returns whether the score of this result is the highest or not.
boolean	hasLowestScore()	Returns whether the score of this result is the lowest or not.
boolean	isPresent()	Returns true if this result is not empty().
@Nullable MediaType	negotiatedResponseMediaType()	Returns the negotiated producible media type.
String	path()	Returns the path mapped by the Route.
Map<String,String>	pathParams()	Returns the path parameters extracted by the Route.
@Nullable String	query()	Returns the query mapped by the Route.
int	score()	Returns the score of this result.
String	toString()
RoutingResultType	type()	Returns the type of this result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

empty

public static RoutingResult empty()

The empty RoutingResult whose type() is RoutingResultType.NOT_MATCHED and isPresent() returns false. It is returned by Route.apply(RoutingContext, boolean) when the RoutingContext did not match the conditions in the Route.

excluded

public static RoutingResult excluded()

The empty RoutingResult whose type() is RoutingResultType.NOT_MATCHED and isPresent() returns false. It is returned by Route.apply(RoutingContext, boolean) when the RoutingContext is acceptable from one of the excludedRoutes.

builder

public static RoutingResultBuilder builder()

Returns a new builder.

type

public RoutingResultType type()

Returns the type of this result.

isPresent

public boolean isPresent()

Returns true if this result is not empty().

path

public String path()

Returns the path mapped by the Route.

Throws:

IllegalStateException - if there's no match

decodedPath

public String decodedPath()

Returns the path mapped by the Route, decoded in UTF-8.

Throws:

IllegalStateException - if there's no match

query

@Nullable
public @Nullable String query()

Returns the query mapped by the Route.

Returns:

the query string, or null if there is no query part.

Throws:

IllegalStateException - if there's no match

pathParams

public Map<String,String> pathParams()

Returns the path parameters extracted by the Route.

Throws:

IllegalStateException - if there's no match

score

public int score()

Returns the score of this result. Integer.MAX_VALUE is the highest score of the result, and Integer.MIN_VALUE is the lowest score of the result.

hasHighestScore

public boolean hasHighestScore()

Returns whether the score of this result is the highest or not.

hasLowestScore

public boolean hasLowestScore()

Returns whether the score of this result is the lowest or not.

negotiatedResponseMediaType

@Nullable
public @Nullable MediaType negotiatedResponseMediaType()

Returns the negotiated producible media type.

toString

public String toString()

Overrides:

toString in class Object