Class UriTemplate
This Class supports Level 1 templates and all Level 4 composite templates as described in: RFC 6570.
Specifically, for the variables: var := "value" list := ["red", "green", "blue"] keys := [("semi", ";"),("dot", "."),("comma", ",")]
The following templates results in the following expansions: {var} -> value {list} -> red,green,blue {list*} -> red,green,blue {keys} -> semi,%3B,dot,.,comma,%2C {keys*} -> semi=%3B,dot=.,comma=%2C {+list} -> red,green,blue {+list*} -> red,green,blue {+keys} -> semi,;,dot,.,comma,, {+keys*} -> semi=;,dot=.,comma=, {#list} -> #red,green,blue {#list*} -> #red,green,blue {#keys} -> #semi,;,dot,.,comma,, {#keys*} -> #semi=;,dot=.,comma=, X{.list} -> X.red,green,blue X{.list*} -> X.red.green.blue X{.keys} -> X.semi,%3B,dot,.,comma,%2C X{.keys*} -> X.semi=%3B.dot=..comma=%2C {/list} -> /red,green,blue {/list*} -> /red/green/blue {/keys} -> /semi,%3B,dot,.,comma,%2C {/keys*} -> /semi=%3B/dot=./comma=%2C {;list} -> ;list=red,green,blue {;list*} -> ;list=red;list=green;list=blue {;keys} -> ;keys=semi,%3B,dot,.,comma,%2C {;keys*} -> ;semi=%3B;dot=.;comma=%2C {?list} -> ?list=red,green,blue {?list*} -> ?list=redinvalid input: '&list'=greeninvalid input: '&list'=blue {?keys} -> ?keys=semi,%3B,dot,.,comma,%2C {?keys*} -> ?semi=%3Binvalid input: '&dot'=.invalid input: '&comma'=%2C {invalid input: '&list'} -> invalid input: '&list'=red,green,blue {invalid input: '&list'*} -> invalid input: '&list'=redinvalid input: '&list'=greeninvalid input: '&list'=blue {invalid input: '&keys'} -> invalid input: '&keys'=semi,%3B,dot,.,comma,%2C {invalid input: '&keys'*} -> invalid input: '&semi'=%3Binvalid input: '&dot'=.invalid input: '&comma'=%2C {?var,list} -> ?var=valueinvalid input: '&list'=red,green,blue
- Since:
- 1.6
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static enum
Contains information on how to output a composite value. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String
private static final Map
<Character, UriTemplate.CompositeOutput> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic String
Expands templates in a URI.static String
Expands templates in a URI template that is relative to a base URL.(package private) static UriTemplate.CompositeOutput
getCompositeOutput
(String propertyName) private static String
getListPropertyValue
(String varName, Iterator<?> iterator, boolean containsExplodeModifier, UriTemplate.CompositeOutput compositeOutput) Expand the template of a composite list property.Constructs a newMap<String, Object>
from anObject
.private static String
getMapPropertyValue
(String varName, Map<String, Object> map, boolean containsExplodeModifier, UriTemplate.CompositeOutput compositeOutput) Expand the template of a composite map property.private static String
getSimpleValue
(String name, String value, UriTemplate.CompositeOutput compositeOutput)
-
Field Details
-
COMPOSITE_PREFIXES
-
COMPOSITE_NON_EXPLODE_JOINER
- See Also:
-
-
Constructor Details
-
UriTemplate
public UriTemplate()
-
-
Method Details
-
getCompositeOutput
-
getMap
Constructs a newMap<String, Object>
from anObject
.There are no null values in the returned map.
-
expand
public static String expand(String baseUrl, String uriTemplate, Object parameters, boolean addUnusedParamsAsQueryParams) Expands templates in a URI template that is relative to a base URL.If the URI template starts with a "/" the raw path from the base URL is stripped out. If the URI template is a full URL then it is used instead of the base URL.
Supports Level 1 templates and all Level 4 composite templates as described in: RFC 6570.
- Parameters:
baseUrl
- The base URL which the URI component is relative to.uriTemplate
- URI component. It may contain one or more sequences of the form "{name}", where "name" must be a key in variableMap.parameters
- an object with parameters designated by Key annotations. If the template has no variable references, parameters may benull
.addUnusedParamsAsQueryParams
- If true then parameters that do not match the template are appended to the expanded template as query parameters.- Returns:
- The expanded template
- Since:
- 1.7
-
expand
public static String expand(String pathUri, Object parameters, boolean addUnusedParamsAsQueryParams) Expands templates in a URI.Supports Level 1 templates and all Level 4 composite templates as described in: RFC 6570.
- Parameters:
pathUri
- URI component. It may contain one or more sequences of the form "{name}", where "name" must be a key in variableMapparameters
- an object with parameters designated by Key annotations. If the template has no variable references, parameters may benull
.addUnusedParamsAsQueryParams
- If true then parameters that do not match the template are appended to the expanded template as query parameters.- Returns:
- The expanded template
- Since:
- 1.6
-
getSimpleValue
private static String getSimpleValue(String name, String value, UriTemplate.CompositeOutput compositeOutput) -
getListPropertyValue
private static String getListPropertyValue(String varName, Iterator<?> iterator, boolean containsExplodeModifier, UriTemplate.CompositeOutput compositeOutput) Expand the template of a composite list property. Eg: If d := ["red", "green", "blue"] then {/d*} is expanded to "/red/green/blue"- Parameters:
varName
- the name of the variable the value corresponds to. E.g. "d"iterator
- the iterator over list values. E.g. ["red", "green", "blue"]compositeOutput
- an instance of CompositeOutput. Contains information on how the expansion should be donecontainsExplodeModifiersSet
- to true if the template contains the explode modifier "*"- Returns:
- the expanded list template
- Throws:
IllegalArgumentException
- if the required list path parameter is empty
-
getMapPropertyValue
private static String getMapPropertyValue(String varName, Map<String, Object> map, boolean containsExplodeModifier, UriTemplate.CompositeOutput compositeOutput) Expand the template of a composite map property. Eg: If d := [("semi", ";"),("dot", "."),("comma", ",")] then {/d*} is expanded to "/semi=%3B/dot=./comma=%2C"- Parameters:
varName
- the name of the variable the value corresponds to. Eg: "d"map
- the map property value. Eg: [("semi", ";"),("dot", "."),("comma", ",")]containsExplodeModifier
- Set to true if the template contains the explode modifier "*"compositeOutput
- contains information on how the expansion should be done- Returns:
- the expanded map template
- Throws:
IllegalArgumentException
- if the required list path parameter is map
-