Index (Handy URI Templates 2.1.6 API)

B C D E F G H I L M O P Q R S T U V W

B

build() - Method in class com.damnhandy.uri.template.Expression.Builder
build() - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Generates a UriTemplate instance from the builder.
buildFromTemplate(String) - Static method in class com.damnhandy.uri.template.UriTemplate: Creates a new UriTemplateBuilder from the template string.
buildFromTemplate(UriTemplate) - Static method in class com.damnhandy.uri.template.UriTemplate: Creates a new UriTemplateBuilder from a root UriTemplate.

C

com.damnhandy.uri.template - package com.damnhandy.uri.template: Handy URI Templates
com.damnhandy.uri.template.impl - package com.damnhandy.uri.template.impl
com.damnhandy.uri.template.jackson.datatype - package com.damnhandy.uri.template.jackson.datatype: These classes allow the UriTemplate class to better integrate with the Jackson JSON framework.
containsOperator(String) - Static method in class com.damnhandy.uri.template.UriTemplate
continuation(VarSpec...) - Static method in class com.damnhandy.uri.template.Expression: Creates a new Expression.Builder to create an expression using form-style query continuation expansion according to section 3.2.9.
continuation(String...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a template expression using the form-style query continuation.
continuation(VarSpec...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a template expression using the form-style query continuation and and optional modifier.
createBuilder() - Static method in class com.damnhandy.uri.template.UriTemplate: Creates a new UriTemplateBuilder instance.

D

DEFAULT_SEPARATOR - Static variable in class com.damnhandy.uri.template.UriTemplate
defaultDateFormat - Variable in class com.damnhandy.uri.template.UriTemplate: Deprecated.
Replaced by defaultDateTimeFormatter
DefaultVarExploder - Class in com.damnhandy.uri.template: The DefaultVarExploder is a VarExploder implementation that takes in a Java object and extracts the properties for use in a URI Template.
DefaultVarExploder(Object) - Constructor for class com.damnhandy.uri.template.DefaultVarExploder
deserialize(JsonParser, DeserializationContext) - Method in class com.damnhandy.uri.template.jackson.datatype.UriTemplateDeserializer

E

encode(String) - Static method in class com.damnhandy.uri.template.UriUtil
encodeFragment(String) - Static method in class com.damnhandy.uri.template.UriUtil
equals(Object) - Method in class com.damnhandy.uri.template.Expression
expand(String, Map<String, Object>) - Static method in class com.damnhandy.uri.template.UriTemplate: Expands the given template string using the variable replacements in the supplied Map.
expand(Map<String, Object>) - Method in class com.damnhandy.uri.template.UriTemplate: Expand the URI template using the supplied values
expand() - Method in class com.damnhandy.uri.template.UriTemplate: Applies variable substitution the URI Template and returns the expanded URI.
expandPartial(String, Map<String, Object>) - Static method in class com.damnhandy.uri.template.UriTemplate: Expands the given template string using the variable replacements in the supplied Map.
expandPartial() - Method in class com.damnhandy.uri.template.UriTemplate
Expression - Class in com.damnhandy.uri.template: An Expression represents the text between '{' and '}', including the enclosing braces, as defined in Section 2 of RFC6570.
Expression(String, int) - Constructor for class com.damnhandy.uri.template.Expression: Create a new Expression.
Expression(Operator, List<VarSpec>) - Constructor for class com.damnhandy.uri.template.Expression: Create a new Expression
Expression.Builder - Class in com.damnhandy.uri.template: Builder class for creating an Expression.
expressionCount() - Method in class com.damnhandy.uri.template.UriTemplate: Returns the number of expressions found in this template

F

fragment(VarSpec...) - Static method in class com.damnhandy.uri.template.Expression: Creates a new Expression.Builder to create an expression with a fragment operator according to section 3.2.4.
fragment(String...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a template expression using the fragment operator (#).
fragment(VarSpec...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a template expression using the fragment operator (#) with a modifier.
fromOpCode(String) - Static method in enum com.damnhandy.uri.template.impl.Operator: FIXME Comment this
fromTemplate(String) - Static method in class com.damnhandy.uri.template.UriTemplate: Creates a new UriTemplate from the template.
fromTemplate(UriTemplate) - Static method in class com.damnhandy.uri.template.UriTemplate: Creates a new UriTemplate from a root UriTemplate.

G

get(String) - Method in class com.damnhandy.uri.template.UriTemplate: FIXME Comment this
getComponents() - Method in class com.damnhandy.uri.template.UriTemplate: Returns the collection of UriTemplateComponent instances found in this template.
getComponents() - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Returns an array of the components in the Builder.
getEncoding() - Method in enum com.damnhandy.uri.template.impl.Operator
getEndPosition() - Method in class com.damnhandy.uri.template.UriTemplateComponent: Get the endPosition.
getExploder(Object, VarSpec) - Static method in class com.damnhandy.uri.template.impl.VarExploderFactory
getExpressions() - Method in class com.damnhandy.uri.template.UriTemplate: Returns an array of Expression instances found in this template.
getListSeparator() - Method in enum com.damnhandy.uri.template.impl.Operator
getLocation() - Method in exception com.damnhandy.uri.template.MalformedUriTemplateException
getMatchPattern() - Method in class com.damnhandy.uri.template.Expression: Returns a string that contains a regular expression that matches the URI template expression.
getMatchPattern() - Method in class com.damnhandy.uri.template.Literal
getMatchPattern() - Method in class com.damnhandy.uri.template.UriTemplateComponent: Returns a string that contains a regular expression that matches the URI template expression.
getModifier() - Method in class com.damnhandy.uri.template.impl.VarSpec: Get the modifier.
getNameValuePairs() - Method in class com.damnhandy.uri.template.DefaultVarExploder
getNameValuePairs() - Method in interface com.damnhandy.uri.template.VarExploder: Returns the properties of the source object a Map of name/value pairs.
getOperator() - Method in class com.damnhandy.uri.template.Expression: Get the Operator value for this expression.
getOperator() - Method in enum com.damnhandy.uri.template.impl.Operator
getPosition() - Method in class com.damnhandy.uri.template.impl.VarSpec: Get the position.
getPrefix() - Method in enum com.damnhandy.uri.template.impl.Operator
getRegExMatchString() - Method in class com.damnhandy.uri.template.impl.VarSpec: Returns a regex pattern that matches the variable.
getReplacementPattern() - Method in class com.damnhandy.uri.template.Expression: Get the replacementToken.
getReverseMatchPattern() - Method in class com.damnhandy.uri.template.UriTemplate: Returns the
getSeparator() - Method in enum com.damnhandy.uri.template.impl.Operator
getStartPosition() - Method in class com.damnhandy.uri.template.UriTemplateComponent: Get the startPosition of the component within the template string.
getTemplate() - Method in class com.damnhandy.uri.template.UriTemplate: Returns the original URI template expression.
getValue() - Method in class com.damnhandy.uri.template.Expression: Returns the value of this component
getValue() - Method in enum com.damnhandy.uri.template.impl.Modifier
getValue() - Method in class com.damnhandy.uri.template.impl.VarSpec: Get the value.
getValue() - Method in class com.damnhandy.uri.template.Literal
getValue() - Method in class com.damnhandy.uri.template.UriTemplateComponent
getValues() - Method in class com.damnhandy.uri.template.DefaultVarExploder
getValues() - Method in class com.damnhandy.uri.template.UriTemplate: Returns the collection of name/value pairs contained in the instance.
getValues() - Method in interface com.damnhandy.uri.template.VarExploder: Returns the properties of the source object a Collection of object values.
getVariableName() - Method in class com.damnhandy.uri.template.impl.VarSpec: Returns the variable name
getVariables() - Method in class com.damnhandy.uri.template.UriTemplate: Returns the list of unique variable names, from all Expression's, in this template.
getVarSpecs() - Method in class com.damnhandy.uri.template.Expression: Get the varSpecs.

H

hashCode() - Method in class com.damnhandy.uri.template.Expression
hasVariable(String) - Method in class com.damnhandy.uri.template.UriTemplate: Returns true if the UriTemplate contains the variableName.

I

isNamed() - Method in enum com.damnhandy.uri.template.impl.Operator

L

label(VarSpec...) - Static method in class com.damnhandy.uri.template.Expression: Creates a new Expression.Builder to create an expression using label expansion according to section 3.2.5.
label(String...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a template expression using the label (.) operator.
label(VarSpec...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a template expression using the label (.) operator and modifier.
Literal - Class in com.damnhandy.uri.template: Represents the non-expression parts of a URI Template
Literal(String, int) - Constructor for class com.damnhandy.uri.template.Literal: Create a new Literal.
literal(String) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a Literal value to the UriTemplate.

M

MalformedUriTemplateException - Exception in com.damnhandy.uri.template: Raised when the the template processor encounters an issue parsing the URI template string.
MalformedUriTemplateException(String, int, Throwable) - Constructor for exception com.damnhandy.uri.template.MalformedUriTemplateException: Create a new UriTemplateParseException.
MalformedUriTemplateException(String, int) - Constructor for exception com.damnhandy.uri.template.MalformedUriTemplateException: Create a new UriTemplateParseException.
matrix(VarSpec...) - Static method in class com.damnhandy.uri.template.Expression: Creates a new Expression.Builder to create an expression using path-style parameter (a.k.a.
matrix(String...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a template expression using the matrix (;) operator.
matrix(VarSpec...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a template expression using the matrix (;) operator and modifier.
Modifier - Enum in com.damnhandy.uri.template.impl

O

Operator - Enum in com.damnhandy.uri.template.impl: An enum representing an operator in a URI Template.

P

parseTemplateString() - Method in class com.damnhandy.uri.template.UriTemplate: Parse the URI template string into the template model.
path(VarSpec...) - Static method in class com.damnhandy.uri.template.Expression: Creates a new Expression.Builder to create an expression using path expansion according to section 3.2.6.
path(String...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a template expression using the path (/) operator.
path(VarSpec...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a template expression using the path (/) operator and modifier.

Q

query(VarSpec...) - Static method in class com.damnhandy.uri.template.Expression: Creates a new Expression.Builder to create an expression using form-style query string expansion according to section 3.2.8.
query(String...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a template expression using the query (?) operator.
query(VarSpec...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a template expression using the query (?) operator and and optional modifier.

R

reserved(VarSpec...) - Static method in class com.damnhandy.uri.template.Expression: Creates a new Expression.Builder to create an expression that will use reserved expansion according to section 3.2.3.
reserved(String...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a template expression using the reserved operator (+).
reserved(VarSpec...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a template expression using the reserved operator (+) along with an optional modifier.

S

scan(String) - Method in class com.damnhandy.uri.template.impl.UriTemplateParser: Scans the URI template looking for literal string components and expressions.
serialize(UriTemplate, JsonGenerator, SerializerProvider) - Method in class com.damnhandy.uri.template.jackson.datatype.UriTemplateSerializer
set(String, Object) - Method in class com.damnhandy.uri.template.UriTemplate: Sets a value on the URI template expression variable.
set(String, Date) - Method in class com.damnhandy.uri.template.UriTemplate: Sets a Date value into the list of variable substitutions using the default DateFormat.
set(Map<String, Object>) - Method in class com.damnhandy.uri.template.UriTemplate: Adds the name/value pairs in the supplied Map to the collection of values within this URI template instance.
simple(VarSpec...) - Static method in class com.damnhandy.uri.template.Expression: Creates a new Expression.Builder to create a simple expression according to section 3.2.2.
simple(String...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a template expression using no operator.
simple(VarSpec...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Appends a template expression using no operator but with an optional modifier.

T

template(UriTemplate...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Parses the template and appends the parsed components to the builder.
template(String...) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Parses the template and appends the parsed components to the builder.
toString() - Method in class com.damnhandy.uri.template.Expression: Returns the string representation of the expression.
toString() - Method in class com.damnhandy.uri.template.impl.VarSpec
toString() - Method in class com.damnhandy.uri.template.Literal

U

UriTemplate - Class in com.damnhandy.uri.template: This is the primary class for creating and manipulating URI templates.
UriTemplate(LinkedList<UriTemplateComponent>) - Constructor for class com.damnhandy.uri.template.UriTemplate: Create a new UriTemplate.
UriTemplate.Encoding - Enum in com.damnhandy.uri.template
UriTemplateBuilder - Class in com.damnhandy.uri.template: A utility class used for programatically generating a UriTemplate.
UriTemplateBuilderException - Exception in com.damnhandy.uri.template: Raised when there is invalid rule in the construction of a URI template, such as applying multiple fragment expressions to a URI template.
UriTemplateBuilderException() - Constructor for exception com.damnhandy.uri.template.UriTemplateBuilderException: Create a new UriTemplateBuilderException.
UriTemplateBuilderException(String) - Constructor for exception com.damnhandy.uri.template.UriTemplateBuilderException: Create a new UriTemplateBuilderException.
UriTemplateBuilderException(Throwable) - Constructor for exception com.damnhandy.uri.template.UriTemplateBuilderException: Create a new UriTemplateBuilderException.
UriTemplateBuilderException(String, Throwable) - Constructor for exception com.damnhandy.uri.template.UriTemplateBuilderException: Create a new UriTemplateBuilderException.
UriTemplateComponent - Class in com.damnhandy.uri.template: A Component.
UriTemplateComponent(int) - Constructor for class com.damnhandy.uri.template.UriTemplateComponent
UriTemplateDeserializer - Class in com.damnhandy.uri.template.jackson.datatype: A JsonDeserializer that deserializes a string into a UriTemplate.
UriTemplateDeserializer() - Constructor for class com.damnhandy.uri.template.jackson.datatype.UriTemplateDeserializer
UriTemplateModule - Class in com.damnhandy.uri.template.jackson.datatype: Uri Template module for Jackson.
UriTemplateModule() - Constructor for class com.damnhandy.uri.template.jackson.datatype.UriTemplateModule: Create a new UriTemplateModule.
UriTemplateParser - Class in com.damnhandy.uri.template.impl: Utility class used to parse the URI template string into a series of components
UriTemplateParser() - Constructor for class com.damnhandy.uri.template.impl.UriTemplateParser
UriTemplateSerializer - Class in com.damnhandy.uri.template.jackson.datatype: A JsonSerializer that serializes a UriTemplate to a JSON string value.
UriTemplateSerializer() - Constructor for class com.damnhandy.uri.template.jackson.datatype.UriTemplateSerializer
UriTransient - Annotation Type in com.damnhandy.uri.template: Marks a field or property as transient so that it is not included in the expansion.
UriUtil - Class in com.damnhandy.uri.template: A light-weight utility class for applying encoding to values that are applied to expression values.
useVarNameWhenExploded() - Method in enum com.damnhandy.uri.template.impl.Operator: When the variable is a Collection, this flag determines if we use the VarSpec name to prefix values.

V

valueOf(String) - Static method in enum com.damnhandy.uri.template.impl.Modifier: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.damnhandy.uri.template.impl.Operator: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.damnhandy.uri.template.impl.VarSpec.VarFormat: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.damnhandy.uri.template.UriTemplate.Encoding: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.damnhandy.uri.template.impl.Modifier: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.damnhandy.uri.template.impl.Operator: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.damnhandy.uri.template.impl.VarSpec.VarFormat: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.damnhandy.uri.template.UriTemplate.Encoding: Returns an array containing the constants of this enum type, in the order they are declared.
var(String) - Static method in class com.damnhandy.uri.template.UriTemplateBuilder: Adds a variable name to the expression.
var(String, boolean) - Static method in class com.damnhandy.uri.template.UriTemplateBuilder: Adds a variable name to the expression with an explode modifier.
var(String, int) - Static method in class com.damnhandy.uri.template.UriTemplateBuilder: Adds a variable name to the expression with a prefix modifier.
VarExploder - Interface in com.damnhandy.uri.template: A VarExploder is invoked when an explode modifier "*" is encountered within a variable name within a URI expression expression and the replacement value is a complex type, such a some type of POJO or other data type.
VarExploderException - Exception in com.damnhandy.uri.template: A VarExploderException.
VarExploderException(String, Throwable) - Constructor for exception com.damnhandy.uri.template.VarExploderException: Create a new VarExploderException.
VarExploderException(Throwable) - Constructor for exception com.damnhandy.uri.template.VarExploderException: Create a new VarExploderException.
VarExploderFactory - Class in com.damnhandy.uri.template.impl
VariableExpansionException - Exception in com.damnhandy.uri.template: Raised when the the template processor encounters an issue expanding the value into the variable at expansion time.
VariableExpansionException(String) - Constructor for exception com.damnhandy.uri.template.VariableExpansionException: Create a new VariableExpansionException.
VariableExpansionException(Throwable) - Constructor for exception com.damnhandy.uri.template.VariableExpansionException: Create a new VariableExpansionException.
VariableExpansionException(String, Throwable) - Constructor for exception com.damnhandy.uri.template.VariableExpansionException: Create a new VariableExpansionException.
VarName - Annotation Type in com.damnhandy.uri.template: When this annotation is placed on a field or getter method, the annotation value will be used instead of the property name.
VarSpec - Class in com.damnhandy.uri.template.impl: Represents a variable in a URI template expression.
VarSpec(String, Modifier) - Constructor for class com.damnhandy.uri.template.impl.VarSpec: Create a new VarSpec.
VarSpec(String, Modifier, Integer) - Constructor for class com.damnhandy.uri.template.impl.VarSpec: Create a new VarSpec.
VarSpec.VarFormat - Enum in com.damnhandy.uri.template.impl

W

withDefaultDateFormat(String) - Method in class com.damnhandy.uri.template.UriTemplate
withDefaultDateFormat(DateFormat) - Method in class com.damnhandy.uri.template.UriTemplate: Deprecated.
replaced by withDefaultDateFormat
withDefaultDateFormat(String) - Method in class com.damnhandy.uri.template.UriTemplateBuilder
withDefaultDateFormat(DateFormat) - Method in class com.damnhandy.uri.template.UriTemplateBuilder: Deprecated.
replaced by withDefaultDateFormat

B C D E F G H I L M O P Q R S T U V W