com.github.fge.uritemplate

Class URITemplate

java.lang.Object

com.github.fge.uritemplate.URITemplate

public final class URITemplate
extends Object

Main URI template class

See Also:

URITemplateParser

Constructor Summary

Constructors

Constructor and Description
URITemplate(String input) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	expand(Map<String,VariableValue> vars) Deprecated. use toString(VariableMap) instead. Will be removed in version 0.6.
String	toString(VariableMap vars) Expand this template to a string given a list of variables
URI	toURI(VariableMap vars) Expand this template to a URI given a set of variables
URL	toURL(VariableMap vars) Expand this template to a URL given a set of variables

Methods inherited from class java.lang.Object

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

Constructor Detail

URITemplate

public URITemplate(String input)
            throws URITemplateParseException

Constructor

Parameters:

input - the input string

Throws:

URITemplateParseException - parse error

Method Detail

expand

@Deprecated
public String expand(Map<String,VariableValue> vars)
              throws URITemplateException

Deprecated. use toString(VariableMap) instead. Will be removed in version 0.6.

Expand this template given a list of variables

Note that this only returns a string. It is up to the caller to verify afterwards that the resulting string is actually a valid URI. The RFC makes no guarantee about that!

Parameters:

vars - the variable map (names as keys, contents as values)

Returns:

expanded string

Throws:

URITemplateException - expansion error (f.e. modifier mismatch)

toString

public String toString(VariableMap vars)
                throws URITemplateException

Expand this template to a string given a list of variables

Parameters:

vars - the variable map (names as keys, contents as values)

Returns:

expanded string

Throws:

URITemplateException - expansion error (f.e. modifier mismatch)

toURI

public URI toURI(VariableMap vars)
          throws URITemplateException,
                 URISyntaxException

Expand this template to a URI given a set of variables

Parameters:

vars - the variables

Returns:

a URI

Throws:

URITemplateException - see toString(VariableMap)

URISyntaxException - expanded string is not a valid URI

toURL

public URL toURL(VariableMap vars)
          throws URITemplateException,
                 MalformedURLException

Expand this template to a URL given a set of variables

Parameters:

vars - the variables

Returns:

a URL

Throws:

URITemplateException - see toString(VariableMap)

MalformedURLException - expanded string is not a valid URL