UriBuilder (Spring Framework 5.2.1.RELEASE API)

All Known Implementing Classes:

ServletUriComponentsBuilder, UriComponentsBuilder
```
public interface UriBuilder
```
Builder-style methods to prepare and expand a URI template with variables.
Effectively a generalization of UriComponentsBuilder but with shortcuts to expand directly into URI rather than UriComponents and also leaving common concerns such as encoding preferences, a base URI, and others as implementation concerns.
Typically obtained via UriBuilderFactory which serves as a central component configured once and used to create many URLs.

Since:

5.0

Author:

Rossen Stoyanchev

See Also:

UriBuilderFactory, UriComponentsBuilder

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`URI`	`build(Map<String,?> uriVariables)` Build a `URI` instance and replaces URI template variables with the values from a map.
`URI`	`build(Object... uriVariables)` Build a `URI` instance and replaces URI template variables with the values from an array.
`UriBuilder`	`fragment(String fragment)` Set the URI fragment.
`UriBuilder`	`host(String host)` Set the URI host which may contain URI template variables, and may also be `null` to clear the host of this builder.
`UriBuilder`	`path(String path)` Append the given path to the existing path of this builder.
`UriBuilder`	`pathSegment(String... pathSegments)` Append path segments to the existing path.
`UriBuilder`	`port(int port)` Set the URI port.
`UriBuilder`	`port(String port)` Set the URI port .
`UriBuilder`	`query(String query)` Append the given query to the existing query of this builder.
`UriBuilder`	`queryParam(String name, Collection<?> values)` Append the given query parameter to the existing query parameters.
`UriBuilder`	`queryParam(String name, Object... values)` Append the given query parameter to the existing query parameters.
`UriBuilder`	`queryParams(MultiValueMap<String,String> params)` Add the given query parameters.
`UriBuilder`	`replacePath(String path)` Set the path of this builder overriding the existing path values.
`UriBuilder`	`replaceQuery(String query)` Set the query of this builder overriding all existing query parameters.
`UriBuilder`	`replaceQueryParam(String name, Collection<?> values)` Set the query parameter values overriding all existing query values for the same parameter.
`UriBuilder`	`replaceQueryParam(String name, Object... values)` Set the query parameter values overriding all existing query values for the same parameter.
`UriBuilder`	`replaceQueryParams(MultiValueMap<String,String> params)` Set the query parameter values overriding all existing query values.
`UriBuilder`	`scheme(String scheme)` Set the URI scheme which may contain URI template variables, and may also be `null` to clear the scheme of this builder.
`UriBuilder`	`userInfo(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.

- Method Detail
  - scheme
```
UriBuilder scheme(@Nullable
                  String scheme)
```
    Set the URI scheme which may contain URI template variables, and may also be null to clear the scheme of this builder.
    
    Parameters:
    
    scheme - the URI scheme
  - userInfo
```
UriBuilder userInfo(@Nullable
                    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.
    
    Parameters:
    
    userInfo - the URI user info
  - host
```
UriBuilder host(@Nullable
                String host)
```
    Set the URI host which may contain URI template variables, and may also be null to clear the host of this builder.
    
    Parameters:
    
    host - the URI host
  - port
```
UriBuilder port(int port)
```
    Set the URI port. Passing -1 will clear the port of this builder.
    
    Parameters:
    
    port - the URI port
  - port
```
UriBuilder port(@Nullable
                String port)
```
    Set the URI port . Use this method only when the port needs to be parameterized with a URI variable. Otherwise use port(int). Passing null will clear the port of this builder.
    
    Parameters:
    
    port - the URI port
  - path
```
UriBuilder path(String path)
```
    Append the given path to the existing path of this builder. The given path may contain URI template variables.
    
    Parameters:
    
    path - the URI path
  - replacePath
```
UriBuilder replacePath(@Nullable
                       String path)
```
    Set the path of this builder overriding the existing path values.
    
    Parameters:
    
    path - the URI path, or null for an empty path
  - pathSegment
```
UriBuilder pathSegment(String... pathSegments)
                throws IllegalArgumentException
```
    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.
    
    Parameters:
    
    pathSegments - the URI path segments
    
    Throws:
    
    IllegalArgumentException
  - query
```
UriBuilder query(String query)
```
    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");
 
```
    Parameters:
    
    query - the query string
  - replaceQuery
```
UriBuilder replaceQuery(@Nullable
                        String query)
```
    Set the query of this builder overriding all existing query parameters.
    
    Parameters:
    
    query - the query string, or null to remove all query params
  - queryParam
```
UriBuilder queryParam(String name,
                      Object... values)
```
    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.
    
    Parameters:
    
    name - the query parameter name
    
    values - the query parameter values
    
    See Also:
    
    queryParam(String, Collection)
  - queryParam
```
UriBuilder queryParam(String name,
                      @Nullable
                      Collection<?> values)
```
    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.
    
    Parameters:
    
    name - the query parameter name
    
    values - the query parameter values
    
    Since:
    
    5.2
    
    See Also:
    
    queryParam(String, Object...)
  - queryParams
```
UriBuilder queryParams(MultiValueMap<String,String> params)
```
    Add the given query parameters.
    
    Parameters:
    
    params - the params
  - replaceQueryParam
```
UriBuilder replaceQueryParam(String name,
                             Object... values)
```
    Set the query parameter values overriding all existing query values for the same parameter. If no values are given, the query parameter is removed.
    
    Parameters:
    
    name - the query parameter name
    
    values - the query parameter values
    
    See Also:
    
    replaceQueryParam(String, Collection)
  - replaceQueryParam
```
UriBuilder replaceQueryParam(String name,
                             @Nullable
                             Collection<?> values)
```
    Set the query parameter values overriding all existing query values for the same parameter. If no values are given, the query parameter is removed.
    
    Parameters:
    
    name - the query parameter name
    
    values - the query parameter values
    
    Since:
    
    5.2
    
    See Also:
    
    replaceQueryParam(String, Object...)
  - replaceQueryParams
```
UriBuilder replaceQueryParams(MultiValueMap<String,String> params)
```
    Set the query parameter values overriding all existing query values.
    
    Parameters:
    
    params - the query parameter name
  - fragment
```
UriBuilder fragment(@Nullable
                    String fragment)
```
    Set the URI fragment. The given fragment may contain URI template variables, and may also be null to clear the fragment of this builder.
    
    Parameters:
    
    fragment - the URI fragment
  - build
```
URI build(Object... uriVariables)
```
    Build a URI instance and replaces URI template variables with the values from an array.
    
    Parameters:
    
    uriVariables - the map of URI variables
    
    Returns:
    
    the URI
  - build
```
URI build(Map<String,?> uriVariables)
```
    Build a URI instance and replaces URI template variables with the values from a map.
    
    Parameters:
    
    uriVariables - the map of URI variables
    
    Returns:
    
    the URI

Interface UriBuilder

Method Summary

Method Detail

scheme

userInfo

host

port

port

path

replacePath

pathSegment

query

replaceQuery

queryParam

queryParam

queryParams

replaceQueryParam

replaceQueryParam

replaceQueryParams

fragment

build

build