public final class TokenLiteral extends Object implements Token, Matchable
Literal text remains identical during the expansion process (parameters are ignored).
Literal text tokens only match text that is equal.
The expression for a literal token does contain curly brackets.
Constructor and Description |
---|
TokenLiteral(String text)
Creates a new literal text token.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o)
Two tokens are equals if and only if their string expression is equal.
|
String |
expand(Parameters parameters)
Expands this object to produce a URI fragment as defined by the URI Template specifications.
|
String |
expression()
The expression corresponding to this token.
|
int |
hashCode() |
boolean |
isResolvable()
Indicates whether this token can be resolved.
|
boolean |
match(String part)
Indicates whether this token matches the specified part of a URL.
|
Pattern |
pattern()
Returns a regular expression pattern corresponding to this object.
|
boolean |
resolve(String expanded,
Map<Variable,Object> values)
Resolves the specified expanded URI part for this token.
|
protected static String |
strip(String exp)
Removes the curly brackets from the specified expression.
|
String |
toString() |
protected static List<Variable> |
toVariables(String exp)
Returns the variables for a given expression containing a list of variables.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
expression, isResolvable
public TokenLiteral(String text)
text
- The text corresponding to this URI token.NullPointerException
- If the specified text is null
.public String expand(Parameters parameters)
Expandable
expand
in interface Expandable
parameters
- The list of parameters and their values for substitution.public boolean match(String part)
Matchable
public Pattern pattern()
Matchable
public boolean resolve(String expanded, Map<Variable,Object> values)
The resolution process requires all variables referenced in the token to be mapped to
the value that is present in the expanded URI data.
By definition, no variable in this token. This method does nothing and always
returns true
.
public boolean isResolvable()
A resolvable token contains variables which can be resolved. By default a token is resolvable if it can be matched.
isResolvable
in interface Token
true
if variables can be resolved from the specified pattern;
false
otherwise.public String expression()
Token
expression
in interface Token
public boolean equals(Object o)
protected static final String strip(String exp)
exp
- The expression to 'strip'.protected static final List<Variable> toVariables(String exp) throws URITemplateSyntaxException
exp
- An expression containing a comma separated list of variables.URITemplateSyntaxException
- If thrown by the Variable parse method.Copyright © 2016 Allette Systems. All rights reserved.