UriTemplate (Handy URI Templates 1.1.7 API)

java.lang.Object
- com.damnhandy.uri.template.UriTemplate

Direct Known Subclasses:

RFC6570UriTemplate
```
public abstract class UriTemplate
extends Object
```
This is the main class for creating and manipulating URI templates. This project implements RFC6570 URI Templates and produces output that is compliant with the spec. The template processor supports levels 1 through 4 as well as supports composite types. In addition to supporting Map and List values as composite types, the library also supports the use of Java objects as well. Please see the VarExploder and DefaultVarExploder for more info.

Basic Usage:

There are many ways to use this library. The simplest way is to create a template from a URI template string:
```
 UriTemplate template = UriTemplate.fromTemplate("http://example.com/search{?q,lang}");
 
```
Replacement values are added by calling the set(String, Object) method on the template:
```
 template.set("q","cat")
         .set("lang","en");                               
 String uri = template.expand();
 
```
The expand() method will replace the variable names with the supplied values and return the following URI:
```
 http://example.com/search?q=cat&lang=en
 
```
Since:

1.0

Version:

$Revision: 1.1 $

Author:

Ryan J. McDonough

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UriTemplate.Encoding

Nested Classes
Modifier and Type	Class and Description
`static class`	`UriTemplate.Encoding`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_SEPARATOR`
`protected DateFormat`	`defaultDateFormat`
`protected Map<String,Object>`	`values` The collection of values that will be applied to the URI expression in the expansion process.

Constructor Summary

Constructors
Constructor and Description

UriTemplate()

Constructors
Constructor and Description
`UriTemplate()`

Method Summary

Methods
Modifier and Type	Method and Description
`UriTemplate`	`append(String template)` Appends the expression from a base URI template expression, such as:
`static boolean`	`containsOperator(String op)`
`abstract String`	`expand()` Applies variable substitution the URI Template and returns the expanded URI.
`abstract String`	`expand(Map<String,Object> vars)` Expand the URI template using the supplied values
`static String`	`expand(String expression, Map<String,Object> values)` Expands the given expression string using the variable replacements in the supplied `Map`.
`UriTemplate`	`expression(String expression)` Deprecated. use `#template(String)` instead
`static UriTemplate`	`fromExpression(String expression)` Deprecated. use `fromTemplate(String)` instead
`static UriTemplate`	`fromTemplate(String template)` Creates a new `UriTemplate` from the template.
`static UriTemplate`	`fromTemplate(UriTemplate base)` Creates a new `UriTemplate` from a root `UriTemplate`.
`String`	`getExpression()` Deprecated. use `getTemplate()` instead.
`String`	`getTemplate()` Returns the original URI template expression.
`Map<String,Object>`	`getValues()` Returns the collection of name/value pairs contained in the instance.
`UriTemplate`	`set(Map<String,Object> values)` Adds the name/value pairs in the supplied `Map` to the collection of values within this URI template instance.
`UriTemplate`	`set(String variableName, Date value)` Sets a Date value into the list of variable substitutions using the default `DateFormat`.
`UriTemplate`	`set(String variableName, Object value)` Sets a value on the URI template expression variable.
`protected void`	`setTemplate(String template)` FIXME Comment this
`UriTemplate`	`withDefaultDateFormat(DateFormat dateFormat)`
`UriTemplate`	`withDefaultDateFormat(String dateFormatString)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_SEPARATOR
```
public static final String DEFAULT_SEPARATOR
```
    See Also:
    Constant Field Values
  - defaultDateFormat
```
protected DateFormat defaultDateFormat
```
  - values
```
protected Map<String,Object> values
```
    The collection of values that will be applied to the URI expression in the expansion process.
- Constructor Detail
  - UriTemplate
```
public UriTemplate()
```
- Method Detail
  - fromExpression
```
@Deprecated
public static final UriTemplate fromExpression(String expression)
```
    Deprecated. use fromTemplate(String) instead
    
    Creates a new UriTemplate from the expression.
    
    Parameters:
    expression -
    
    Returns:
    Since:
    
    1.0
  - fromTemplate
```
public static final UriTemplate fromTemplate(String template)
```
    Creates a new UriTemplate from the template.
    
    Parameters:
    expression -
    
    Returns:
    Since:
    
    1.2
  - fromTemplate
```
public static UriTemplate fromTemplate(UriTemplate base)
```
    Creates a new UriTemplate from a root UriTemplate. This method will create a new UriTemplate from the base and copy the variables from the base template to the new UriTemplate.
    
    This method is useful when the base template is less volatile than the child expression and you want to merge the two.
    
    Parameters:
    base -
    
    Returns:
    Since:
    
    1.0
  - expand
```
public static String expand(String expression,
            Map<String,Object> values)
```
    Expands the given expression string using the variable replacements in the supplied Map.
    
    Parameters:
    expression -
    values -
    
    Returns:
    Since:
    
    1.0
  - getExpression
```
@Deprecated
public String getExpression()
```
    Deprecated. use getTemplate() instead.
    
    Returns the original URI template expression.
    
    Returns:
    Since:
    
    1.0
  - getTemplate
```
public String getTemplate()
```
    Returns the original URI template expression.
    
    Returns:
    Since:
    
    1.1.4
  - append
```
public UriTemplate append(String template)
```
    Appends the expression from a base URI template expression, such as:
```
 UriTemplate template = UriTemplate.fromExpression("http://api.github.com");
 
```
    A child expression can be appended by:
```
 UriTemplate template = UriTemplate.fromExpression("http://api.github.com")
                                   .expression("/repos/{user}/{repo}/commits");
 
 
```
    The resulting expression would result in:
```
 http://api.github.com/repos/{user}/{repo}/commits
 
```
    Multiple expressions can be appended to the template as follows:
```
  UriTemplate template = UriTemplate.fromTemplate("http://myhost")
                                    .append("{/version}")
                                    .append("{/myId}")
                                    .append("/things/{thingId}")
                                    .set("myId","damnhandy")
                                    .set("version","v1")
                                    .set("thingId","12345");
 
```
    This will result in the following template and URI:
```
 Template: http://myhost{/version}{/myId}/things/{thingId}
 URI:      http://myhost/v1/damnhandy/things/12345
 
```
    Since a URI template is not a URI, there no way to accurately determine how the variable expression should be delimited. Therefore, it is up to the expression author to include the necessary delimiters in each sub expression.
    Parameters:
    template -
    
    Returns:
    Since:
    
    1.1.4
  - expression
```
@Deprecated
public UriTemplate expression(String expression)
```
    Deprecated. use #template(String) instead
    
    FIXME Comment this
    
    Parameters:
    expression -
    
    Returns:
  - setTemplate
```
protected void setTemplate(String template)
```
    FIXME Comment this
    
    Parameters:
    template -
  - getValues
```
public Map<String,Object> getValues()
```
    Returns the collection of name/value pairs contained in the instance.
    
    Returns:
    Since:
    
    1.0
  - withDefaultDateFormat
```
public UriTemplate withDefaultDateFormat(String dateFormatString)
```
    Parameters:
    dateFormatString -
    
    Returns:
    Since:
    
    1.0
  - withDefaultDateFormat
```
public UriTemplate withDefaultDateFormat(DateFormat dateFormat)
```
    Parameters:
    dateFormat -
    
    Returns:
    Since:
    
    1.0
  - set
```
public UriTemplate set(String variableName,
              Object value)
```
    Sets a value on the URI template expression variable.
    
    Parameters:
    variableName -
    value -
    
    Returns:
    Since:
    
    1.0
  - set
```
public UriTemplate set(String variableName,
              Date value)
```
    Sets a Date value into the list of variable substitutions using the default DateFormat.
    
    Parameters:
    variableName -
    value -
    
    Returns:
    Since:
    
    1.0
  - set
```
public UriTemplate set(Map<String,Object> values)
```
    Adds the name/value pairs in the supplied Map to the collection of values within this URI template instance.
    
    Parameters:
    values -
    
    Returns:
    Since:
    
    1.0
  - expand
```
public abstract String expand(Map<String,Object> vars)
```
    Expand the URI template using the supplied values
    
    Parameters:
    vars - The values that will be used in the expansion
    
    Returns:
    the expanded URI as a String
    Since:
    
    1.0
  - expand
```
public abstract String expand()
```
    Applies variable substitution the URI Template and returns the expanded URI.
    
    Returns:
    Since:
    
    1.0
  - containsOperator
```
public static boolean containsOperator(String op)
```
    Parameters:
    op -
    
    Returns:

Class UriTemplate

Basic Usage:

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SEPARATOR

defaultDateFormat

values

Constructor Detail

UriTemplate

Method Detail

fromExpression

fromTemplate

fromTemplate

expand

getExpression

getTemplate

append

expression

setTemplate

getValues

withDefaultDateFormat

withDefaultDateFormat

set

set

set

expand

expand

containsOperator