Package com.duncpro.jroute.util

Class ParameterizedRoute

java.lang.Object

com.duncpro.jroute.route.Route

com.duncpro.jroute.util.ParameterizedRoute

public class ParameterizedRoute
extends Route

This class is an ergonomic wrapper around Route which associates a label with each WildcardRouteElement in a Route. This class does not represent a unique type of Route, instead it is simply a utility to make accessing the variable elements in a path more ergonomic. Since ParameterizedRoute is simply a Route, two instances can be equal even if their parameter labels differ, so long as each route contains the same RouteElements in the same order. Moreover, a ParameterizedRoute can be equal to a Route, as long as the aforementioned condition is true.

Field Summary

Fields inherited from class com.duncpro.jroute.route.Route

ROOT

Constructor Summary

Constructors

Constructor	Description
ParameterizedRoute(java.util.List<java.lang.String> parameterLabels, java.util.List<RouteElement> elements)	Creates a ParameterizedRoute where the ith string in the labels list corresponds to the ith WildcardRouteElement in the elements list.

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.String>	extractVariablesMap(Path path)	Returns a mapping of parameters to arguments given some Path whose structure matches the Route represented by this ParameterizedRoute.
java.util.List<java.lang.String>	getParameterLabels()
static ParameterizedRoute	parse(java.lang.String routeString)	Constructs a ParameterizedRoute given a parameterized route string.

Methods inherited from class com.duncpro.jroute.route.Route

concat, equals, extractVariables, extractVariables, getElements, hashCode, isRoot, resolve, toString, withLeadingElement, withoutLeadingElement, withTrailingElement

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterizedRoute

public ParameterizedRoute(java.util.List<java.lang.String> parameterLabels,
                          java.util.List<RouteElement> elements)

Creates a ParameterizedRoute where the ith string in the labels list corresponds to the ith WildcardRouteElement in the elements list. See also parse(String), which constructs a ParameterizedRoute from a human-readable parameterized route string.

Method Detail

getParameterLabels

public java.util.List<java.lang.String> getParameterLabels()

extractVariablesMap

public java.util.Map<java.lang.String,java.lang.String> extractVariablesMap(Path path)

Returns a mapping of parameters to arguments given some Path whose structure matches the Route represented by this ParameterizedRoute. For example a parameterized route string of '/customers/{customerId}/orders/{orderId}', and path of "/customers/duncan/orders/abc123" would result in a return value of [(customerId, duncan), (orderId, abc123)].

parse

public static ParameterizedRoute parse(java.lang.String routeString)

Constructs a ParameterizedRoute given a parameterized route string. For example: "/customers/{customerId}/orders/{orderId}".

Throws:

java.lang.IllegalArgumentException - if the route string is malformed.