public abstract class UriBuilder extends Object
Path.value()
for an explanation of URI templates.
Builder methods perform contextual encoding of characters not permitted in
the corresponding URI component following the rules of the
application/x-www-form-urlencoded
media type for query parameters and
RFC 3986 for all other
components. Note that only characters not permitted in a particular component
are subject to encoding so, e.g., a path supplied to one of the path
methods may contain matrix parameters or multiple path segments since the
separators are legal characters and will not be encoded. Percent encoded
values are also recognized where allowed and will not be double encoded.
URI templates are allowed in most components of a URI but their value is restricted to a particular component. E.g.
UriBuilder.fromPath("{arg1}").build("foo#bar");
would result in encoding of the '#' such that the resulting URI is
"foo%23bar". To create a URI "foo#bar" use
UriBuilder.fromPath("{arg1}").fragment("{arg2}").build("foo", "bar")
instead. URI template names and delimiters are never encoded but their
values are encoded when a URI is built.
Template parameter regular expressions are ignored when building a URI, i.e.
no validation is performed.Modifier | Constructor and Description |
---|---|
protected |
UriBuilder()
Protected constructor, use one of the static
fromXxx(...)
methods to obtain an instance. |
Modifier and Type | Method and Description |
---|---|
abstract URI |
build(Object... values)
Build a URI, using the supplied values in order to replace any URI
template parameters.
|
abstract URI |
build(Object[] values,
boolean encodeSlashInPath)
Build a URI, using the supplied values in order to replace any URI
template parameters.
|
abstract URI |
buildFromEncoded(Object... values)
Build a URI.
|
abstract URI |
buildFromEncodedMap(Map<String,?> values)
Build a URI.
|
abstract URI |
buildFromMap(Map<String,?> values)
Build a URI.
|
abstract URI |
buildFromMap(Map<String,?> values,
boolean encodeSlashInPath)
Build a URI.
|
abstract UriBuilder |
clone()
Create a copy of the UriBuilder preserving its state.
|
abstract UriBuilder |
fragment(String fragment)
Set the URI fragment.
|
static UriBuilder |
fromLink(Link link)
Create a new instance initialized from a Link.
|
static UriBuilder |
fromMethod(Class<?> resource,
String method)
Create a new instance representing a relative URI initialized from a
Path -annotated method. |
static UriBuilder |
fromPath(String path)
Create a new instance representing a relative URI initialized from a
URI path.
|
static UriBuilder |
fromResource(Class<?> resource)
Create a new instance representing a relative URI initialized from a
root resource class.
|
static UriBuilder |
fromUri(String uriTemplate)
Create a new instance initialized from an existing URI.
|
static UriBuilder |
fromUri(URI uri)
Create a new instance initialized from an existing URI.
|
abstract UriBuilder |
host(String host)
Set the URI host.
|
abstract UriBuilder |
matrixParam(String name,
Object... values)
Append a matrix parameter to the existing set of matrix parameters of
the current final segment of the URI path.
|
protected static UriBuilder |
newInstance()
Creates a new instance of UriBuilder.
|
abstract UriBuilder |
path(Class resource)
Append the path from a Path-annotated class to the
existing path.
|
abstract UriBuilder |
path(Class resource,
String method)
Append the path from a Path-annotated method to the
existing path.
|
abstract UriBuilder |
path(Method method)
Append the path from a
Path -annotated method to the
existing path. |
abstract UriBuilder |
path(String path)
Append path to the existing path.
|
abstract UriBuilder |
port(int port)
Set the URI port.
|
abstract UriBuilder |
queryParam(String name,
Object... values)
Append a query parameter to the existing set of query parameters.
|
abstract UriBuilder |
replaceMatrix(String matrix)
Set the matrix parameters of the current final segment of the current URI path.
|
abstract UriBuilder |
replaceMatrixParam(String name,
Object... values)
Replace the existing value(s) of a matrix parameter on
the current final segment of the URI path.
|
abstract UriBuilder |
replacePath(String path)
Set the URI path.
|
abstract UriBuilder |
replaceQuery(String query)
Set the URI query string.
|
abstract UriBuilder |
replaceQueryParam(String name,
Object... values)
Replace the existing value(s) of a query parameter.
|
abstract UriBuilder |
resolveTemplate(String name,
Object value)
Resolve a URI template with a given
name in this UriBuilder instance
using a supplied value. |
abstract UriBuilder |
resolveTemplate(String name,
Object value,
boolean encodeSlashInPath)
Resolve a URI template with a given
name in this UriBuilder instance
using a supplied value. |
abstract UriBuilder |
resolveTemplateFromEncoded(String name,
Object value)
Resolve a URI template with a given
name in this UriBuilder instance
using a supplied encoded value. |
abstract UriBuilder |
resolveTemplates(Map<String,Object> templateValues)
Resolve one or more URI templates in this
UriBuilder instance using supplied
name-value pairs. |
abstract UriBuilder |
resolveTemplates(Map<String,Object> templateValues,
boolean encodeSlashInPath)
Resolve one or more URI templates in this
UriBuilder instance using supplied
name-value pairs. |
abstract UriBuilder |
resolveTemplatesFromEncoded(Map<String,Object> templateValues)
Resolve one or more URI templates in this
UriBuilder instance using supplied
name-value pairs. |
abstract UriBuilder |
scheme(String scheme)
Set the URI scheme.
|
abstract UriBuilder |
schemeSpecificPart(String ssp)
Set the URI scheme-specific-part (see
URI ). |
abstract UriBuilder |
segment(String... segments)
Append path segments to the existing path.
|
abstract String |
toTemplate()
Get the URI template string represented by this URI builder.
|
abstract UriBuilder |
uri(String uriTemplate)
Parses the
uriTemplate string and copies the parsed components of the supplied
URI to the UriBuilder replacing any existing values for those components. |
abstract UriBuilder |
uri(URI uri)
Copies the non-null components of the supplied URI to the UriBuilder replacing
any existing values for those components.
|
abstract UriBuilder |
userInfo(String ui)
Set the URI user-info.
|
protected UriBuilder()
fromXxx(...)
methods to obtain an instance.protected static UriBuilder newInstance()
public static UriBuilder fromUri(URI uri)
uri
- a URI that will be used to initialize the UriBuilder.IllegalArgumentException
- if uri is null
.public static UriBuilder fromUri(String uriTemplate)
uriTemplate
- a URI template that will be used to initialize the UriBuilder, may
contain URI parameters.IllegalArgumentException
- if uriTemplate
is not a valid URI template or
is null
.public static UriBuilder fromLink(Link link)
link
- a Link that will be used to initialize the UriBuilder, only
its URI is used.IllegalArgumentException
- if link is null
public static UriBuilder fromPath(String path) throws IllegalArgumentException
path
- a URI path that will be used to initialize the UriBuilder,
may contain URI template parameters.IllegalArgumentException
- if path is null
.public static UriBuilder fromResource(Class<?> resource)
resource
- a root resource whose Path
value will
be used to initialize the UriBuilder.IllegalArgumentException
- if resource is not annotated with
Path
or resource is null
.public static UriBuilder fromMethod(Class<?> resource, String method)
Path
-annotated method.
This method can only be used in cases where there is a single method with the
specified name that is annotated with Path
.resource
- the resource containing the method.method
- the name of the method whose Path
value will be
used to obtain the path to append.IllegalArgumentException
- if resource or method is null
,
or there is more than or less than one variant of the method annotated with
Path
.public abstract UriBuilder clone()
build(Object...)
method.public abstract UriBuilder uri(URI uri)
uri
- the URI to copy components from.IllegalArgumentException
- if the uri
parameter is null
.public abstract UriBuilder uri(String uriTemplate)
uriTemplate
string and copies the parsed components of the supplied
URI to the UriBuilder replacing any existing values for those components.uriTemplate
- a URI template that will be used to initialize the UriBuilder, may
contain URI parameters.IllegalArgumentException
- if uriTemplate
is not a valid URI template or
is null
.public abstract UriBuilder scheme(String scheme)
scheme
- the URI scheme, may contain URI template parameters.
A null
value will unset the URI scheme, but will
not unset the any scheme-specific-part components.IllegalArgumentException
- if scheme is invalid.public abstract UriBuilder schemeSpecificPart(String ssp)
URI
). This
method will overwrite any existing
values for authority, user-info, host, port and path.ssp
- the URI scheme-specific-part, may contain URI template parameters.IllegalArgumentException
- if ssp cannot be parsed or is null
.public abstract UriBuilder userInfo(String ui)
ui
- the URI user-info, may contain URI template parameters.
A null
value will unset userInfo component of the URI.public abstract UriBuilder host(String host)
host
- the URI host, may contain URI template parameters.
A null
value will unset the host component of the URI, but
will not unset other authority component parts
(user info
or port
).IllegalArgumentException
- if host is invalid.public abstract UriBuilder port(int port)
port
- the URI port, a value of -1 will unset an explicit port.IllegalArgumentException
- if port is invalid.public abstract UriBuilder replacePath(String path)
path
- the path, may contain URI template parameters.
A null
value will unset the path component of the URI.public abstract UriBuilder path(String path)
path
- the path, may contain URI template parameters.IllegalArgumentException
- if path is null
.public abstract UriBuilder path(Class resource)
resource
- a resource whose Path
value will be
used to obtain the path to append.IllegalArgumentException
- if resource is null
, or
if resource is not annotated with Path
.public abstract UriBuilder path(Class resource, String method)
path(Method)
, it
can only be used in cases where there is a single method with the
specified name that is annotated with Path
.resource
- the resource containing the method.method
- the name of the method whose Path
value will be
used to obtain the path to append.IllegalArgumentException
- if resource or method is null
,
or there is more than or less than one variant of the method annotated with
Path
.public abstract UriBuilder path(Method method)
Path
-annotated method to the
existing path.
When constructing the final path, a '/' separator will be inserted
between the existing path and the supplied path if necessary.method
- a method whose Path
value will be
used to obtain the path to append to the existing path.IllegalArgumentException
- if method is null
or is
not annotated with a Path
.public abstract UriBuilder segment(String... segments)
segments
- the path segment values, each may contain URI template
parameters.IllegalArgumentException
- if segments or any element of segments
is null
.public abstract UriBuilder replaceMatrix(String matrix)
matrix
- the matrix parameters, may contain URI template parameters.
A null
value will remove all matrix parameters of the current final segment
of the current URI path.IllegalArgumentException
- if matrix cannot be parsed.public abstract UriBuilder matrixParam(String name, Object... values)
name
- the matrix parameter name, may contain URI template parameters.values
- the matrix parameter value(s), each object will be converted.
to a String
using its toString()
method. Stringified
values may contain URI template parameters.IllegalArgumentException
- if name or values is null
.public abstract UriBuilder replaceMatrixParam(String name, Object... values)
name
- the matrix parameter name, may contain URI template parameters.values
- the matrix parameter value(s), each object will be converted.
to a String
using its toString()
method. Stringified
values may contain URI template parameters. If values
is empty
or null
then all current values of the parameter are removed.IllegalArgumentException
- if name is null
.public abstract UriBuilder replaceQuery(String query)
query
- the URI query string, may contain URI template parameters.
A null
value will remove all query parameters.IllegalArgumentException
- if query cannot be parsed.public abstract UriBuilder queryParam(String name, Object... values)
name
- the query parameter name, may contain URI template parameters.values
- the query parameter value(s), each object will be converted
to a String
using its toString()
method. Stringified
values may contain URI template parameters.IllegalArgumentException
- if name or values is null
.public abstract UriBuilder replaceQueryParam(String name, Object... values)
name
- the query parameter name, may contain URI template parameters.values
- the query parameter value(s), each object will be converted
to a String
using its toString()
method. Stringified
values may contain URI template parameters. If values
is empty
or null
then all current values of the parameter are removed.IllegalArgumentException
- if name is null
.public abstract UriBuilder fragment(String fragment)
fragment
- the URI fragment, may contain URI template parameters.
A null
value will remove any existing fragment.public abstract UriBuilder resolveTemplate(String name, Object value)
name
in this UriBuilder
instance
using a supplied value.
In case a null
template name or value is entered a IllegalArgumentException
is thrown.name
- name of the URI template.value
- value to be used to resolve the template.IllegalArgumentException
- if the resolved template name or value is null
.public abstract UriBuilder resolveTemplate(String name, Object value, boolean encodeSlashInPath)
name
in this UriBuilder
instance
using a supplied value.
In case a null
template name or value is entered a IllegalArgumentException
is thrown.name
- name of the URI template.value
- value to be used to resolve the template.encodeSlashInPath
- if true
, the slash ('/'
) characters
in template values will be encoded if the template
is placed in the URI path component, otherwise the slash
characters will not be encoded in path templates.IllegalArgumentException
- if the resolved template name or value is null
.public abstract UriBuilder resolveTemplateFromEncoded(String name, Object value)
name
in this UriBuilder
instance
using a supplied encoded value.
A template with a matching name will be replaced by the supplied value.
Value is converted to String
using its toString()
method and is then
encoded to match the rules of the URI component to which they pertain. All % characters in
the stringified values that are not followed by two hexadecimal numbers will be encoded.
In case a null
template name or encoded value is entered a IllegalArgumentException
is thrown.name
- name of the URI template.value
- encoded value to be used to resolve the template.IllegalArgumentException
- if the resolved template name or encoded value is null
.public abstract UriBuilder resolveTemplates(Map<String,Object> templateValues)
UriBuilder
instance using supplied
name-value pairs.
A call to the method with an empty parameter map is ignored.templateValues
- a map of URI template names and their values.IllegalArgumentException
- if the name-value map or any of the names or values
in the map is null
.public abstract UriBuilder resolveTemplates(Map<String,Object> templateValues, boolean encodeSlashInPath) throws IllegalArgumentException
UriBuilder
instance using supplied
name-value pairs.
A call to the method with an empty parameter map is ignored.templateValues
- a map of URI template names and their values.encodeSlashInPath
- if true
, the slash ('/'
) characters
in template values will be encoded if the template
is placed in the URI path component, otherwise the slash
characters will not be encoded in path templates.IllegalArgumentException
- if the name-value map or any of the names or values
in the map is null
.public abstract UriBuilder resolveTemplatesFromEncoded(Map<String,Object> templateValues)
UriBuilder
instance using supplied
name-value pairs.
All templates with their name matching one of the keys in the supplied map will be replaced
by the value in the supplied map. Values are converted to String
using
their toString()
method and are then encoded to match the
rules of the URI component to which they pertain. All % characters in
the stringified values that are not followed by two hexadecimal numbers
will be encoded.
A call to the method with an empty parameter map is ignored.templateValues
- a map of URI template names and their values.IllegalArgumentException
- if the name-value map or any of the names or values
in the map is null
.public abstract URI buildFromMap(Map<String,?> values)
String
using
their toString()
method and are then encoded to match the
rules of the URI component to which they pertain. All '%'
characters
in the stringified values will be encoded.
The state of the builder is unaffected; this method may be called
multiple times on the same builder instance.
NOTE: By default all '/'
characters in the stringified values will be
encoded in path templates, i.e. the result is identical to invoking
buildFromMap(valueMap, true)
.
To override this behavior use buildFromMap(valueMap, false)
instead.
values
- a map of URI template parameter names and values.IllegalArgumentException
- if there are any URI template parameters
without a supplied value, or if a template parameter value is null
.UriBuilderException
- if a URI cannot be constructed based on the
current state of the builder.buildFromMap(java.util.Map, boolean)
,
buildFromEncodedMap(java.util.Map)
public abstract URI buildFromMap(Map<String,?> values, boolean encodeSlashInPath) throws IllegalArgumentException, UriBuilderException
String
using
their toString()
method and are then encoded to match the
rules of the URI component to which they pertain. All '%'
characters
in the stringified values will be encoded.
The state of the builder is unaffected; this method may be called
multiple times on the same builder instance.
The encodeSlashInPath
parameter may be used to override the default
encoding of '/'
characters in the stringified template values
in cases when the template is part of the URI path component when using
the buildFromMap(java.util.Map)
method. If the encodeSlashInPath
parameter is set to true
(default), the slash ('/'
) characters in
parameter values will be encoded if the template is placed in the URI path component.
If set to false
the default encoding behavior is overridden an slash characters
in template values will not be encoded when used to substitute path templates.
values
- a map of URI template parameter names and values.encodeSlashInPath
- if true
, the slash ('/'
) characters
in parameter values will be encoded if the template
is placed in the URI path component, otherwise the slash
characters will not be encoded in path templates.IllegalArgumentException
- if there are any URI template parameters
without a supplied value, or if a template parameter value is null
.UriBuilderException
- if a URI cannot be constructed based on the
current state of the builder.buildFromMap(java.util.Map)
,
buildFromEncodedMap(java.util.Map)
public abstract URI buildFromEncodedMap(Map<String,?> values) throws IllegalArgumentException, UriBuilderException
String
using
their toString()
method and are then encoded to match the
rules of the URI component to which they pertain. All % characters in
the stringified values that are not followed by two hexadecimal numbers
will be encoded.
The state of the builder is unaffected; this method may be called
multiple times on the same builder instance.values
- a map of URI template parameter names and values.IllegalArgumentException
- if there are any URI template parameters
without a supplied value, or if a template parameter value is null
.UriBuilderException
- if a URI cannot be constructed based on the
current state of the builder.buildFromMap(java.util.Map)
,
buildFromMap(java.util.Map, boolean)
public abstract URI build(Object... values) throws IllegalArgumentException, UriBuilderException
String
using
their toString()
method and are then encoded to match the
rules of the URI component to which they pertain. All '%' characters
in the stringified values will be encoded.
The state of the builder is unaffected; this method may be called
multiple times on the same builder instance.
All instances of the same template parameter will be replaced by the same value that corresponds to the position of the first instance of the template parameter. e.g. the template "{a}/{b}/{a}" with values {"x", "y", "z"} will result in the the URI "x/y/x", not "x/y/z".
NOTE: By default all '/'
characters in the stringified values will be
encoded in path templates, i.e. the result is identical to invoking
build(Object[], boolean)
build(values, true)}.
To override this behavior use build(values, false)
instead.
values
- a list of URI template parameter values.IllegalArgumentException
- if there are any URI template parameters
without a supplied value, or if a value is null
.UriBuilderException
- if a URI cannot be constructed based on the
current state of the builder.build(Object[], boolean)
,
buildFromEncoded(Object...)
public abstract URI build(Object[] values, boolean encodeSlashInPath) throws IllegalArgumentException, UriBuilderException
String
using
their toString()
method and are then encoded to match the
rules of the URI component to which they pertain. All '%' characters
in the stringified values will be encoded.
The state of the builder is unaffected; this method may be called
multiple times on the same builder instance.
All instances of the same template parameter will be replaced by the same value that corresponds to the position of the first instance of the template parameter. e.g. the template "{a}/{b}/{a}" with values {"x", "y", "z"} will result in the the URI "x/y/x", not "x/y/z".
The encodeSlashInPath
parameter may be used to override the default
encoding of '/'
characters in the stringified template values
in cases when the template is part of the URI path component when using
the build(Object[])
method. If the encodeSlashInPath
parameter is set to true
(default), the slash ('/'
) characters in
parameter values will be encoded if the template is placed in the URI path component.
If set to false
the default encoding behavior is overridden an slash characters
in template values will not be encoded when used to substitute path templates.
values
- a list of URI template parameter values.encodeSlashInPath
- if true
, the slash ('/'
) characters
in parameter values will be encoded if the template
is placed in the URI path component, otherwise the slash
characters will not be encoded in path templates.IllegalArgumentException
- if there are any URI template parameters
without a supplied value, or if a value is null
.UriBuilderException
- if a URI cannot be constructed based on the
current state of the builder.build(Object[])
,
buildFromEncoded(Object...)
public abstract URI buildFromEncoded(Object... values) throws IllegalArgumentException, UriBuilderException
String
using
their toString()
method and are then encoded to match the
rules of the URI component to which they pertain. All % characters in
the stringified values that are not followed by two hexadecimal numbers
will be encoded.
The state of the builder is unaffected; this method may be called
multiple times on the same builder instance.
All instances of the same template parameter will be replaced by the same value that corresponds to the position of the first instance of the template parameter. e.g. the template "{a}/{b}/{a}" with values {"x", "y", "z"} will result in the the URI "x/y/x", not "x/y/z".
values
- a list of URI template parameter values.IllegalArgumentException
- if there are any URI template parameters
without a supplied value, or if a value is null
.UriBuilderException
- if a URI cannot be constructed based on the
current state of the builder.build(Object[])
,
build(Object[], boolean)
public abstract String toTemplate()
Copyright © 2013. All Rights Reserved.