private class DefaultUriBuilderFactory.DefaultUriBuilder extends java.lang.Object implements UriBuilder
DefaultUriBuilderFactory
specific implementation of UriBuilder.Modifier and Type | Field and Description |
---|---|
private UriComponentsBuilder |
uriComponentsBuilder |
Constructor and Description |
---|
DefaultUriBuilder(java.lang.String uriTemplate) |
Modifier and Type | Method and Description |
---|---|
java.net.URI |
build(java.util.Map<java.lang.String,?> uriVars)
Build a
URI instance and replaces URI template variables
with the values from a map. |
java.net.URI |
build(java.lang.Object... uriVars)
Build a
URI instance and replaces URI template variables
with the values from an array. |
DefaultUriBuilderFactory.DefaultUriBuilder |
fragment(java.lang.String fragment)
Set the URI fragment.
|
DefaultUriBuilderFactory.DefaultUriBuilder |
host(java.lang.String host)
Set the URI host which may contain URI template variables, and may also
be
null to clear the host of this builder. |
private UriComponentsBuilder |
initUriComponentsBuilder(java.lang.String uriTemplate) |
DefaultUriBuilderFactory.DefaultUriBuilder |
path(java.lang.String path)
Append the given path to the existing path of this builder.
|
DefaultUriBuilderFactory.DefaultUriBuilder |
pathSegment(java.lang.String... pathSegments)
Append path segments to the existing path.
|
DefaultUriBuilderFactory.DefaultUriBuilder |
port(int port)
Set the URI port.
|
DefaultUriBuilderFactory.DefaultUriBuilder |
port(java.lang.String port)
Set the URI port .
|
DefaultUriBuilderFactory.DefaultUriBuilder |
query(java.lang.String query)
Append the given query to the existing query of this builder.
|
DefaultUriBuilderFactory.DefaultUriBuilder |
queryParam(java.lang.String name,
java.lang.Object... values)
Append the given query parameter to the existing query parameters.
|
DefaultUriBuilderFactory.DefaultUriBuilder |
queryParams(MultiValueMap<java.lang.String,java.lang.String> params)
Add the given query parameters.
|
DefaultUriBuilderFactory.DefaultUriBuilder |
replacePath(java.lang.String path)
Set the path of this builder overriding the existing path values.
|
DefaultUriBuilderFactory.DefaultUriBuilder |
replaceQuery(java.lang.String query)
Set the query of this builder overriding all existing query parameters.
|
DefaultUriBuilderFactory.DefaultUriBuilder |
replaceQueryParam(java.lang.String name,
java.lang.Object... values)
Set the query parameter values overriding all existing query values for
the same parameter.
|
DefaultUriBuilderFactory.DefaultUriBuilder |
replaceQueryParams(MultiValueMap<java.lang.String,java.lang.String> params)
Set the query parameter values overriding all existing query values.
|
DefaultUriBuilderFactory.DefaultUriBuilder |
scheme(java.lang.String scheme)
Set the URI scheme which may contain URI template variables,
and may also be
null to clear the scheme of this builder. |
DefaultUriBuilderFactory.DefaultUriBuilder |
userInfo(java.lang.String userInfo)
Set the URI user info which may contain URI template variables, and
may also be
null to clear the user info of this builder. |
private final UriComponentsBuilder uriComponentsBuilder
private UriComponentsBuilder initUriComponentsBuilder(java.lang.String uriTemplate)
public DefaultUriBuilderFactory.DefaultUriBuilder scheme(@Nullable java.lang.String scheme)
UriBuilder
null
to clear the scheme of this builder.scheme
in interface UriBuilder
scheme
- the URI schemepublic DefaultUriBuilderFactory.DefaultUriBuilder userInfo(@Nullable java.lang.String userInfo)
UriBuilder
null
to clear the user info of this builder.userInfo
in interface UriBuilder
userInfo
- the URI user infopublic DefaultUriBuilderFactory.DefaultUriBuilder host(@Nullable java.lang.String host)
UriBuilder
null
to clear the host of this builder.host
in interface UriBuilder
host
- the URI hostpublic DefaultUriBuilderFactory.DefaultUriBuilder port(int port)
UriBuilder
-1
will clear the port of this builder.port
in interface UriBuilder
port
- the URI portpublic DefaultUriBuilderFactory.DefaultUriBuilder port(@Nullable java.lang.String port)
UriBuilder
UriBuilder.port(int)
.
Passing null
will clear the port of this builder.port
in interface UriBuilder
port
- the URI portpublic DefaultUriBuilderFactory.DefaultUriBuilder path(java.lang.String path)
UriBuilder
path
in interface UriBuilder
path
- the URI pathpublic DefaultUriBuilderFactory.DefaultUriBuilder replacePath(@Nullable java.lang.String path)
UriBuilder
replacePath
in interface UriBuilder
path
- the URI path, or null
for an empty pathpublic DefaultUriBuilderFactory.DefaultUriBuilder pathSegment(java.lang.String... pathSegments)
UriBuilder
path("/")
subsequently to ensure a trailing slash.pathSegment
in interface UriBuilder
pathSegments
- the URI path segmentspublic DefaultUriBuilderFactory.DefaultUriBuilder query(java.lang.String query)
UriBuilder
Note: The presence of reserved characters can prevent
correct parsing of the URI string. For example if a query parameter
contains '='
or '&'
characters, the query string cannot
be parsed unambiguously. Such values should be substituted for URI
variables to enable correct parsing:
builder.query("filter={value}").uriString("hot&cold");
query
in interface UriBuilder
query
- the query stringpublic DefaultUriBuilderFactory.DefaultUriBuilder replaceQuery(@Nullable java.lang.String query)
UriBuilder
replaceQuery
in interface UriBuilder
query
- the query string, or null
to remove all query paramspublic DefaultUriBuilderFactory.DefaultUriBuilder queryParam(java.lang.String name, java.lang.Object... values)
UriBuilder
?foo
instead of ?foo=bar
.queryParam
in interface UriBuilder
name
- the query parameter namevalues
- the query parameter valuespublic DefaultUriBuilderFactory.DefaultUriBuilder replaceQueryParam(java.lang.String name, java.lang.Object... values)
UriBuilder
replaceQueryParam
in interface UriBuilder
name
- the query parameter namevalues
- the query parameter valuespublic DefaultUriBuilderFactory.DefaultUriBuilder queryParams(MultiValueMap<java.lang.String,java.lang.String> params)
UriBuilder
queryParams
in interface UriBuilder
params
- the paramspublic DefaultUriBuilderFactory.DefaultUriBuilder replaceQueryParams(MultiValueMap<java.lang.String,java.lang.String> params)
UriBuilder
replaceQueryParams
in interface UriBuilder
params
- the query parameter namepublic DefaultUriBuilderFactory.DefaultUriBuilder fragment(@Nullable java.lang.String fragment)
UriBuilder
null
to clear the fragment of this builder.fragment
in interface UriBuilder
fragment
- the URI fragmentpublic java.net.URI build(java.util.Map<java.lang.String,?> uriVars)
UriBuilder
URI
instance and replaces URI template variables
with the values from a map.build
in interface UriBuilder
uriVars
- the map of URI variablespublic java.net.URI build(java.lang.Object... uriVars)
UriBuilder
URI
instance and replaces URI template variables
with the values from an array.build
in interface UriBuilder
uriVars
- the map of URI variables