org.springframework.web.util

Class DefaultUriBuilderFactory.DefaultUriBuilder

java.lang.Object

org.springframework.web.util.DefaultUriBuilderFactory.DefaultUriBuilder

All Implemented Interfaces:

UriBuilder

Enclosing class:

DefaultUriBuilderFactory

private class DefaultUriBuilderFactory.DefaultUriBuilder
extends java.lang.Object
implements UriBuilder

DefaultUriBuilderFactory specific implementation of UriBuilder.

Field Summary

Fields

Modifier and Type	Field and Description
private UriComponentsBuilder	uriComponentsBuilder

Constructor Summary

Constructors

Constructor and Description
DefaultUriBuilder(java.lang.String uriTemplate)

Method Summary

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.
private java.net.URI	createUri(UriComponents uric)
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)
private void	parsePathIfNecessary(UriComponentsBuilder result)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

uriComponentsBuilder

private final UriComponentsBuilder uriComponentsBuilder

Constructor Detail

DefaultUriBuilder

public DefaultUriBuilder(java.lang.String uriTemplate)

Method Detail

initUriComponentsBuilder

private UriComponentsBuilder initUriComponentsBuilder(java.lang.String uriTemplate)

parsePathIfNecessary

private void parsePathIfNecessary(UriComponentsBuilder result)

scheme

public DefaultUriBuilderFactory.DefaultUriBuilder scheme(@Nullable
                                                         java.lang.String scheme)

Description copied from interface: UriBuilder

Set the URI scheme which may contain URI template variables, and may also be null to clear the scheme of this builder.

Specified by:

scheme in interface UriBuilder

Parameters:

scheme - the URI scheme

userInfo

public DefaultUriBuilderFactory.DefaultUriBuilder userInfo(@Nullable
                                                           java.lang.String userInfo)

Description copied from interface: UriBuilder

Set the URI user info which may contain URI template variables, and may also be null to clear the user info of this builder.

Specified by:

userInfo in interface UriBuilder

Parameters:

userInfo - the URI user info

host

public DefaultUriBuilderFactory.DefaultUriBuilder host(@Nullable
                                                       java.lang.String host)

Description copied from interface: UriBuilder

Set the URI host which may contain URI template variables, and may also be null to clear the host of this builder.

Specified by:

host in interface UriBuilder

Parameters:

host - the URI host

port

public DefaultUriBuilderFactory.DefaultUriBuilder port(int port)

Description copied from interface: UriBuilder

Set the URI port. Passing -1 will clear the port of this builder.

Specified by:

port in interface UriBuilder

Parameters:

port - the URI port

port

public DefaultUriBuilderFactory.DefaultUriBuilder port(@Nullable
                                                       java.lang.String port)

Description copied from interface: UriBuilder

Set the URI port . Use this method only when the port needs to be parameterized with a URI variable. Otherwise use UriBuilder.port(int). Passing null will clear the port of this builder.

Specified by:

port in interface UriBuilder

Parameters:

port - the URI port

path

public DefaultUriBuilderFactory.DefaultUriBuilder path(java.lang.String path)

Description copied from interface: UriBuilder

Append the given path to the existing path of this builder. The given path may contain URI template variables.

Specified by:

path in interface UriBuilder

Parameters:

path - the URI path

replacePath

public DefaultUriBuilderFactory.DefaultUriBuilder replacePath(@Nullable
                                                              java.lang.String path)

Description copied from interface: UriBuilder

Set the path of this builder overriding the existing path values.

Specified by:

replacePath in interface UriBuilder

Parameters:

path - the URI path, or null for an empty path

pathSegment

public DefaultUriBuilderFactory.DefaultUriBuilder pathSegment(java.lang.String... pathSegments)

Description copied from interface: UriBuilder

Append path segments to the existing path. Each path segment may contain URI template variables and should not contain any slashes. Use path("/") subsequently to ensure a trailing slash.

Specified by:

pathSegment in interface UriBuilder

Parameters:

pathSegments - the URI path segments

query

public DefaultUriBuilderFactory.DefaultUriBuilder query(java.lang.String query)

Description copied from interface: UriBuilder

Append the given query to the existing query of this builder. The given query may contain URI template variables.

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");
 

Specified by:

query in interface UriBuilder

Parameters:

query - the query string

replaceQuery

public DefaultUriBuilderFactory.DefaultUriBuilder replaceQuery(@Nullable
                                                               java.lang.String query)

Description copied from interface: UriBuilder

Set the query of this builder overriding all existing query parameters.

Specified by:

replaceQuery in interface UriBuilder

Parameters:

query - the query string, or null to remove all query params

queryParam

public DefaultUriBuilderFactory.DefaultUriBuilder queryParam(java.lang.String name,
                                                             java.lang.Object... values)

Description copied from interface: UriBuilder

Append the given query parameter to the existing query parameters. The given name or any of the values may contain URI template variables. If no values are given, the resulting URI will contain the query parameter name only (i.e. ?foo instead of ?foo=bar.

Specified by:

queryParam in interface UriBuilder

Parameters:

name - the query parameter name

values - the query parameter values

replaceQueryParam

public DefaultUriBuilderFactory.DefaultUriBuilder replaceQueryParam(java.lang.String name,
                                                                    java.lang.Object... values)

Description copied from interface: UriBuilder

Set the query parameter values overriding all existing query values for the same parameter. If no values are given, the query parameter is removed.

Specified by:

replaceQueryParam in interface UriBuilder

Parameters:

name - the query parameter name

values - the query parameter values

queryParams

public DefaultUriBuilderFactory.DefaultUriBuilder queryParams(MultiValueMap<java.lang.String,java.lang.String> params)

Description copied from interface: UriBuilder

Add the given query parameters.

Specified by:

queryParams in interface UriBuilder

Parameters:

params - the params

replaceQueryParams

public DefaultUriBuilderFactory.DefaultUriBuilder replaceQueryParams(MultiValueMap<java.lang.String,java.lang.String> params)

Description copied from interface: UriBuilder

Set the query parameter values overriding all existing query values.

Specified by:

replaceQueryParams in interface UriBuilder

Parameters:

params - the query parameter name

fragment

public DefaultUriBuilderFactory.DefaultUriBuilder fragment(@Nullable
                                                           java.lang.String fragment)

Description copied from interface: UriBuilder

Set the URI fragment. The given fragment may contain URI template variables, and may also be null to clear the fragment of this builder.

Specified by:

fragment in interface UriBuilder

Parameters:

fragment - the URI fragment

build

public java.net.URI build(java.util.Map<java.lang.String,?> uriVars)

Description copied from interface: UriBuilder

Build a URI instance and replaces URI template variables with the values from a map.

Specified by:

build in interface UriBuilder

Parameters:

uriVars - the map of URI variables

Returns:

the URI

build

public java.net.URI build(java.lang.Object... uriVars)

Description copied from interface: UriBuilder

Build a URI instance and replaces URI template variables with the values from an array.

Specified by:

build in interface UriBuilder

Parameters:

uriVars - the map of URI variables

Returns:

the URI

createUri

private java.net.URI createUri(UriComponents uric)