java.lang.Object
- org.springframework.web.util.UriComponents

All Implemented Interfaces:
Serializable
```
public abstract class UriComponents
extends Object
implements Serializable
```
Represents an immutable collection of URI components, mapping component type to String values. Contains convenience getters for all components. Effectively similar to URI, but with more powerful encoding options and support for URI template variables.
Since:
3.1
Author:
Arjen Poutsma, Juergen Hoeller, Rossen Stoyanchev
See Also:
UriComponentsBuilder, Serialized Form

Nested Class Summary
Nested Classes
Modifier and Type Class Description
static interface UriComponents.UriTemplateVariables
Defines the contract for URI Template variables

Constructor Summary
Constructors
Modifier Constructor Description
protected UriComponents(String scheme, String fragment)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract void`	`copyToUriComponentsBuilder(UriComponentsBuilder builder)`	Set all components of the given UriComponentsBuilder.
`UriComponents`	`encode()`	Encode all URI components using their specific encoding rules, and returns the result as a new `UriComponents` instance.
`abstract UriComponents`	`encode(String encoding)`	Encode all URI components using their specific encoding rules, and returns the result as a new `UriComponents` instance.
`UriComponents`	`expand(Object... uriVariableValues)`	Replace all URI template variables with the values from a given array.
`UriComponents`	`expand(Map<String,?> uriVariables)`	Replace all URI template variables with the values from a given map.
`UriComponents`	`expand(UriComponents.UriTemplateVariables uriVariables)`	Replace all URI template variables with the values from the given `UriComponents.UriTemplateVariables`.
`String`	`getFragment()`	Return the fragment.
`abstract String`	`getHost()`	Return the host.
`abstract String`	`getPath()`	Return the path.
`abstract List<String>`	`getPathSegments()`	Return the list of path segments.
`abstract int`	`getPort()`	Return the port.
`abstract String`	`getQuery()`	Return the query.
`abstract MultiValueMap<String,String>`	`getQueryParams()`	Return the map of query parameters.
`String`	`getScheme()`	Return the scheme.
`abstract String`	`getSchemeSpecificPart()`	Return the scheme specific part.
`abstract String`	`getUserInfo()`	Return the user info.
`abstract UriComponents`	`normalize()`	Normalize the path removing sequences like "path/..".
`String`	`toString()`
`abstract URI`	`toUri()`	Return a `URI` from this `UriComponents` instance.
`abstract String`	`toUriString()`	Return a URI String from this `UriComponents` instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UriComponents
```
protected UriComponents(String scheme,
                        String fragment)
```
- Method Detail
  - getScheme
```
public final String getScheme()
```
    Return the scheme. Can be null.
  - getFragment
```
public final String getFragment()
```
    Return the fragment. Can be null.
  - getSchemeSpecificPart
```
public abstract String getSchemeSpecificPart()
```
    Return the scheme specific part. Can be null.
  - getUserInfo
```
public abstract String getUserInfo()
```
    Return the user info. Can be null.
  - getHost
```
public abstract String getHost()
```
    Return the host. Can be null.
  - getPort
```
public abstract int getPort()
```
    Return the port. -1 if no port has been set.
  - getPath
```
public abstract String getPath()
```
    Return the path. Can be null.
  - getPathSegments
```
public abstract List<String> getPathSegments()
```
    Return the list of path segments. Empty if no path has been set.
  - getQuery
```
public abstract String getQuery()
```
    Return the query. Can be null.
  - getQueryParams
```
public abstract MultiValueMap<String,String> getQueryParams()
```
    Return the map of query parameters. Empty if no query has been set.
  - encode
```
public final UriComponents encode()
```
    Encode all URI components using their specific encoding rules, and returns the result as a new UriComponents instance. This method uses UTF-8 to encode.
    Returns:
    the encoded URI components
  - encode
```
public abstract UriComponents encode(String encoding)
                              throws UnsupportedEncodingException
```
    Encode all URI components using their specific encoding rules, and returns the result as a new UriComponents instance.
    Parameters:
    encoding - the encoding of the values contained in this map
    Returns:
    the encoded URI components
    Throws:
    UnsupportedEncodingException - if the given encoding is not supported
  - expand
```
public final UriComponents expand(Map<String,?> uriVariables)
```
    Replace all URI template variables with the values from a given map.
    The given map keys represent variable names; the corresponding values represent variable values. The order of variables is not significant.
    Parameters:
    uriVariables - the map of URI variables
    Returns:
    the expanded URI components
  - expand
```
public final UriComponents expand(Object... uriVariableValues)
```
    Replace all URI template variables with the values from a given array.
    The given array represents variable values. The order of variables is significant.
    Parameters:
    uriVariableValues - the URI variable values
    Returns:
    the expanded URI components
  - expand
```
public final UriComponents expand(UriComponents.UriTemplateVariables uriVariables)
```
    Replace all URI template variables with the values from the given UriComponents.UriTemplateVariables.
    Parameters:
    uriVariables - the URI template values
    Returns:
    the expanded URI components
  - normalize
```
public abstract UriComponents normalize()
```
    Normalize the path removing sequences like "path/..".
    See Also:
    StringUtils.cleanPath(String)
  - toUriString
```
public abstract String toUriString()
```
    Return a URI String from this UriComponents instance.
  - toUri
```
public abstract URI toUri()
```
    Return a URI from this UriComponents instance.
  - toString
```
public final String toString()
```
    Overrides:
    toString in class Object
  - copyToUriComponentsBuilder
```
protected abstract void copyToUriComponentsBuilder(UriComponentsBuilder builder)
```
    Set all components of the given UriComponentsBuilder.
    Since:
    4.2

Class UriComponents

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UriComponents

Method Detail

getScheme

getFragment

getSchemeSpecificPart

getUserInfo

getHost

getPort

getPath

getPathSegments

getQuery

getQueryParams

encode

encode

expand

expand

expand

normalize

toUriString

toUri

toString

copyToUriComponentsBuilder