Package com.damnhandy.uri.template
Handy URI Templates
This package contains the core classes for manipulating and processing different types of URI Templates. At present, it is only supports RFC6570 URI Templates.
- Since:
- 1.0.0
- Author:
- Ryan J. McDonough
-
Interface Summary Interface Description VarExploder AVarExploder
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. -
Class Summary Class Description DefaultVarExploder TheDefaultVarExploder
is aVarExploder
implementation that takes in a Java object and extracts the properties for use in a URI Template.Expression An Expression represents the text between '{' and '}', including the enclosing braces, as defined in Section 2 of RFC6570.Expression.Builder Builder class for creating anExpression
.Literal Represents the non-expression parts of a URI TemplateUriTemplate This is the primary class for creating and manipulating URI templates.UriTemplateBuilder A utility class used for programatically generating aUriTemplate
.UriTemplateComponent A Component.UriUtil A light-weight utility class for applying encoding to values that are applied to expression values. -
Enum Summary Enum Description UriTemplate.Encoding -
Exception Summary Exception Description MalformedUriTemplateException Raised when the the template processor encounters an issue parsing the URI template string.UriTemplateBuilderException Raised when there is invalid rule in the construction of a URI template, such as applying multiple fragment expressions to a URI template.VarExploderException A VarExploderException.VariableExpansionException Raised when the the template processor encounters an issue expanding the value into the variable at expansion time. -
Annotation Types Summary Annotation Type Description UriTransient Marks a field or property as transient so that it is not included in the expansion.VarName When this annotation is placed on a field or getter method, the annotation value will be used instead of the property name.