org.mule.module.apikit.uri

Class URITemplate

java.lang.Object

org.mule.module.apikit.uri.URITemplate

Direct Known Subclasses:

URIPattern

public class URITemplate
extends Object

A URI Template for constructing URIs following the same structure.

Instances of this class implement the URI templates as defined by the URI Template (Draft 3) by Joe Gregorio.

A URI Template follows the URI syntax and can be expanded given a set of variable values.

Version:

5 November 2009

Author:

Christophe Lauret

See Also:

URI Template (draft 3)

Constructor Summary

Constructors

Constructor and Description
URITemplate(String template) Creates a new URI Template instance.

Method Summary

Modifier and Type	Method and Description
static List<Token>	digest(String template) Returns the list of tokens corresponding to the specified URI template.
static List<Token>	digest(String template, TokenFactory factory) Returns the list of tokens corresponding to the specified URI template.
boolean	equals(Object o)
int	hashCode()
List<Token>	tokens() Returns the underlying list of tokens.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

URITemplate

public URITemplate(String template)
            throws IllegalArgumentException

Creates a new URI Template instance.

Parameters:

template - A String following the URI template syntax.

Throws:

NullPointerException - If the specified template is null.

URITemplateSyntaxException - If the string provided does not follow the proper syntax.

IllegalArgumentException

Method Detail

digest

public static List<Token> digest(String template)
                          throws URITemplateSyntaxException

Returns the list of tokens corresponding to the specified URI template.

Parameters:

template - The URI template to digest.

Returns:

The corresponding list of URL tokens.

Throws:

URITemplateSyntaxException - If the string cannot be parsed.

digest

public static List<Token> digest(String template,
                                 TokenFactory factory)
                          throws URITemplateSyntaxException

Returns the list of tokens corresponding to the specified URI template.

Parameters:

template - The URI template to digest.

Returns:

The corresponding list of URL tokens.

Throws:

URITemplateSyntaxException - If the string cannot be parsed.

tokens

public List<Token> tokens()

Returns the underlying list of tokens.

Note: this method exposes the underlying structure of this class and should remain protected.

Returns:

The underlying list of tokens.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object