com.whitestein.lsps.common.rest

Class PathTemplate

java.lang.Object

com.whitestein.lsps.common.rest.PathTemplate

All Implemented Interfaces:

java.lang.Comparable<PathTemplate>

public class PathTemplate
extends java.lang.Object
implements java.lang.Comparable<PathTemplate>

A path template for RESTful web services.

The path template can contain variables in curly brackets. The variable has the following syntax:

 {<variable-name>[:<regular-expression>]}
 

If the regular expression is not specified then the default pattern is used: ([^/]+?) when matching this template with a path.

Examples of path expression

/customers/{id}
/customer/{name: [\w]+?}/address

This class implements comparable. Paths which are considered more specific are considered less then those more generic.

Author:

jsa

Constructor Summary

Constructors

Constructor and Description
PathTemplate(java.lang.String template) Creates a new path template for a RESTful web service.

Method Summary

Modifier and Type	Method and Description
int	compareTo(PathTemplate o)
java.util.Map<java.lang.String,java.lang.String>	extractVariableValues(java.lang.String path) Extracts the template variable values from the path.
java.lang.String	getTemplate() Gets a template string from which this path template was created.
java.util.Collection<java.lang.String>	getVariableNames() Gets variable names extracted from the path template.
boolean	matches(java.lang.String path) Tells whether or not this template matches the given path.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathTemplate

public PathTemplate(java.lang.String template)
             throws InvalidPathTemplateException

Creates a new path template for a RESTful web service.

Parameters:

template - the path template

Throws:

InvalidPathTemplateException - if the template is not a valid path template

Method Detail

matches

public boolean matches(java.lang.String path)

Tells whether or not this template matches the given path.

Parameters:

path - the path this template should be matched to

Returns:

true if this template matches the given path; otherwise false.

extractVariableValues

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

Extracts the template variable values from the path. The path must match this template.

Parameters:

path - the path to be matched

Returns:

a map of variable values mapped by their names.

Throws:

java.lang.IllegalArgumentException - if the path does not match this template.

getVariableNames

public java.util.Collection<java.lang.String> getVariableNames()

Gets variable names extracted from the path template.

Returns:

a collection of variable names.

getTemplate

public java.lang.String getTemplate()

Gets a template string from which this path template was created.

Returns:

the template

compareTo

public int compareTo(PathTemplate o)

Specified by:

compareTo in interface java.lang.Comparable<PathTemplate>