Modifier and Type	Class and Description
private static class	UriComponents.MapTemplateVariables URI template variables backed by a map.
public static interface	UriComponents.UriTemplateVariables Defines the contract for URI Template variables.
private static class	UriComponents.VarArgsTemplateVariables URI template variables backed by a variable argument array.

Modifier and Type	Field and Description
private final String	fragment
private static final Pattern	NAMES_PATTERN Captures URI template variable names.
private final String	scheme

Access	Constructor and Description
protected	UriComponents(String scheme, String fragment)

Method Summary

Modifier and Type	Method and Description
protected abstract void	copyToUriComponentsBuilder(UriComponentsBuilder builder) Set all components of the given UriComponentsBuilder.
public final UriComponents	encode() Invoke this after expanding URI variables to encode the resulting URI component values.
public abstract UriComponents	encode(Charset the charset to use for encoding charset) A variant of `encode()` with a charset other than "UTF-8".
public final UriComponents	Returns: the expanded URI components expand(Map<String, ?> the map of URI variables uriVariables) Replace all URI template variables with the values from a given map.
public final UriComponents	Returns: the expanded URI components expand(Object... the URI variable values uriVariableValues) Replace all URI template variables with the values from a given array.
public final UriComponents	Returns: the expanded URI components expand(UriComponents.UriTemplateVariables the URI template values uriVariables) Replace all URI template variables with the values from the given `UriTemplateVariables`.
pack-priv abstract UriComponents	Returns: the expanded URI components expandInternal(UriComponents.UriTemplateVariables the URI template values uriVariables) Replace all URI template variables with the values from the given `UriTemplateVariables`.
pack-priv static String	expandUriComponent(String source, UriComponents.UriTemplateVariables uriVariables)
pack-priv static String	expandUriComponent(String source, UriComponents.UriTemplateVariables uriVariables, UnaryOperator<String> encoder)
public final String	getFragment() Return the fragment.
public abstract String	getHost() Return the host.
public abstract String	getPath() Return the path.
public abstract List<String>	getPathSegments() Return the list of path segments.
public abstract int	getPort() Return the port.
public abstract String	getQuery() Return the query.
public abstract MultiValueMap<String, String>	getQueryParams() Return the map of query parameters.
public final String	getScheme() Return the scheme.
public abstract String	getSchemeSpecificPart() Return the scheme specific part.
public abstract String	getUserInfo() Return the user info.
private static String	getVariableName(String match)
private static String	getVariableValueAsString(Object variableValue)
public abstract UriComponents	normalize() Normalize the path removing sequences like "path/..".
private static String	sanitizeSource(String source) Remove nested "{}" such as in URI vars with regular expressions.
public final String	toString() Overrides java.lang.Object.toString. A simple pass-through to `toUriString()`.
public abstract URI	toUri() Create a `URI` from this instance as follows: If the current instance is `encoded`, form the full URI String via `toUriString()`, and then pass it to the single argument `URI` constructor which preserves percent encoding.
public abstract String	toUriString() Concatenate all URI components to return the fully formed URI String.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

fragment	back to summary
private final String fragment Annotations @Nullable

NAMES_PATTERN	back to summary
private static final Pattern NAMES_PATTERN Captures URI template variable names.

scheme	back to summary
private final String scheme Annotations @Nullable

Constructor Detail

UriComponents	back to summary
protected UriComponents(String scheme, String fragment)

Method Detail

copyToUriComponentsBuilder	back to summary
protected abstract void copyToUriComponentsBuilder(UriComponentsBuilder builder) Set all components of the given UriComponentsBuilder. Since 4.2

copyToUriComponentsBuilder

back to summary

protected abstract void copyToUriComponentsBuilder(UriComponentsBuilder builder)

Set all components of the given UriComponentsBuilder.

Since: 4.2

encode back to summary

encode	back to summary
public final UriComponents encode() Invoke this after expanding URI variables to encode the resulting URI component values. In comparison to `UriComponentsBuilder#encode()`, this method only replaces non-ASCII and illegal (within a given URI component type) characters, but not characters with reserved meaning. For most cases, `UriComponentsBuilder#encode()` is more likely to give the expected result. See Also `UriComponentsBuilder#encode()`

public final UriComponents encode()

Invoke this after expanding URI variables to encode the resulting URI component values.

In comparison to UriComponentsBuilder#encode(), this method only replaces non-ASCII and illegal (within a given URI component type) characters, but not characters with reserved meaning. For most cases, UriComponentsBuilder#encode() is more likely to give the expected result.

See Also: UriComponentsBuilder#encode()

encode back to summary

encode	back to summary
public abstract UriComponents encode(Charset charset) A variant of `encode()` with a charset other than "UTF-8". Parameters charset:Charset the charset to use for encoding See Also `UriComponentsBuilder#encode(Charset)`

public abstract UriComponents encode(Charset charset)

A variant of encode() with a charset other than "UTF-8".

Parameters

charset:Charset: the charset to use for encoding

See Also

UriComponentsBuilder#encode(Charset)

expand	back to summary
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:Map<String, ?> the map of URI variables Returns:UriComponents the expanded URI components

expand

back to summary

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:Map<String, ?>: the map of URI variables

Returns:UriComponents

the expanded URI components

expand	back to summary
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:Object[] the URI variable values Returns:UriComponents the expanded URI components

expand

back to summary

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:Object[]: the URI variable values

Returns:UriComponents

the expanded URI components

expand back to summary

expand	back to summary
public final UriComponents expand(UriComponents.UriTemplateVariables uriVariables) Replace all URI template variables with the values from the given `UriTemplateVariables`. Parameters uriVariables:UriComponents.UriTemplateVariables the URI template values Returns:UriComponents the expanded URI components

public final UriComponents expand(UriComponents.UriTemplateVariables uriVariables)

Replace all URI template variables with the values from the given UriTemplateVariables.

Parameters

uriVariables:UriComponents.UriTemplateVariables: the URI template values

Returns:UriComponents

the expanded URI components

expandInternal back to summary

expandInternal	back to summary
pack-priv abstract UriComponents expandInternal(UriComponents.UriTemplateVariables uriVariables) Replace all URI template variables with the values from the given `UriTemplateVariables`. Parameters uriVariables:UriComponents.UriTemplateVariables the URI template values Returns:UriComponents the expanded URI components

pack-priv abstract UriComponents expandInternal(UriComponents.UriTemplateVariables uriVariables)

Replace all URI template variables with the values from the given UriTemplateVariables.

Parameters

uriVariables:UriComponents.UriTemplateVariables: the URI template values

Returns:UriComponents

the expanded URI components

expandUriComponent	back to summary
pack-priv static String expandUriComponent(String source, UriComponents.UriTemplateVariables uriVariables) Annotations @Nullable

expandUriComponent	back to summary
pack-priv static String expandUriComponent(String source, UriComponents.UriTemplateVariables uriVariables, UnaryOperator<String> encoder) Annotations @Nullable

getFragment back to summary

getFragment	back to summary
public final String getFragment() Return the fragment. Can be `null`. Annotations @Nullable

public final String getFragment()

Return the fragment. Can be null.

Annotations

@Nullable

getHost back to summary

getHost	back to summary
public abstract String getHost() Return the host. Can be `null`. Annotations @Nullable

public abstract String getHost()

Return the host. Can be null.

Annotations

@Nullable

getPath back to summary

getPath	back to summary
public abstract String getPath() Return the path. Can be `null`. Annotations @Nullable

public abstract String getPath()

Return the path. Can be null.

Annotations

@Nullable

getPathSegments	back to summary
public abstract List<String> getPathSegments() Return the list of path segments. Empty if no path has been set.

getPort	back to summary
public abstract int getPort() Return the port. `-1` if no port has been set.

getQuery back to summary

getQuery	back to summary
public abstract String getQuery() Return the query. Can be `null`. Annotations @Nullable

public abstract String getQuery()

Return the query. Can be null.

Annotations

@Nullable

getQueryParams	back to summary
public abstract MultiValueMap<String, String> getQueryParams() Return the map of query parameters. Empty if no query has been set.

getScheme back to summary

getScheme	back to summary
public final String getScheme() Return the scheme. Can be `null`. Annotations @Nullable

public final String getScheme()

Return the scheme. Can be null.

Annotations

@Nullable

getSchemeSpecificPart back to summary

getSchemeSpecificPart	back to summary
public abstract String getSchemeSpecificPart() Return the scheme specific part. Can be `null`. Annotations @Nullable

public abstract String getSchemeSpecificPart()

Return the scheme specific part. Can be null.

Annotations

@Nullable

getUserInfo back to summary

getUserInfo	back to summary
public abstract String getUserInfo() Return the user info. Can be `null`. Annotations @Nullable

public abstract String getUserInfo()

Return the user info. Can be null.

Annotations

@Nullable

getVariableName	back to summary
private static String getVariableName(String match)

getVariableValueAsString	back to summary
private static String getVariableValueAsString(Object variableValue)

normalize back to summary

normalize	back to summary
public abstract UriComponents normalize() Normalize the path removing sequences like "path/..". Note that normalization is applied to the full path, and not to individual path segments. See Also `org.springframework.util.StringUtils#cleanPath(String)`

public abstract UriComponents normalize()

Normalize the path removing sequences like "path/..". Note that normalization is applied to the full path, and not to individual path segments.

See Also: org.springframework.util.StringUtils#cleanPath(String)

sanitizeSource	back to summary
private static String sanitizeSource(String source) Remove nested "{}" such as in URI vars with regular expressions.

toString back to summary

toString	back to summary
public final String toString() Overrides java.lang.Object.toString. A simple pass-through to `toUriString()`. Returns:String Doc from java.lang.Object.toString. a string representation of the object. Annotations @Override

public final String toString()

Overrides java.lang.Object.toString.

A simple pass-through to toUriString().

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations

@Override

toUri back to summary

toUri	back to summary
public abstract URI toUri() Create a `URI` from this instance as follows: If the current instance is `encoded`, form the full URI String via `toUriString()`, and then pass it to the single argument `URI` constructor which preserves percent encoding. If not yet encoded, pass individual URI component values to the multi-argument `URI` constructor which quotes illegal characters that cannot appear in their respective URI component.

public abstract URI toUri()

Create a URI from this instance as follows:

If the current instance is encoded, form the full URI String via toUriString(), and then pass it to the single argument URI constructor which preserves percent encoding.

If not yet encoded, pass individual URI component values to the multi-argument URI constructor which quotes illegal characters that cannot appear in their respective URI component.

toUriString back to summary

toUriString	back to summary
public abstract String toUriString() Concatenate all URI components to return the fully formed URI String. This method amounts to simple String concatenation of the current URI component values and as such the result may contain illegal URI characters, for example if URI variables have not been expanded or if encoding has not been applied via `UriComponentsBuilder#encode()` or `encode()`.

public abstract String toUriString()

Concatenate all URI components to return the fully formed URI String.

This method amounts to simple String concatenation of the current URI component values and as such the result may contain illegal URI characters, for example if URI variables have not been expanded or if encoding has not been applied via UriComponentsBuilder#encode() or encode().

org.springframework.web.util back to summary

private Class UriComponents.MapTemplateVariables

Class Inheritance

extends Object
implements UriTemplateVariables

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

All Implemented Interfaces

org.springframework.web.util.UriComponents.UriTemplateVariables

URI template variables backed by a map.

Field Summary

Modifier and Type	Field and Description
private final Map<String, ?>	uriVariables

Constructor Summary

Access	Constructor and Description
public	MapTemplateVariables(Map<String, ?> uriVariables)

Method Summary

Modifier and Type	Method and Description
public Object	getValue(String the variable name name) Implements org.springframework.web.util.UriComponents.UriTemplateVariables.getValue. Get the value for the given URI variable name.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

uriVariables	back to summary
private final Map<String, ?> uriVariables

Constructor Detail

MapTemplateVariables	back to summary
public MapTemplateVariables(Map<String, ?> uriVariables)

Method Detail

getValue back to summary

getValue	back to summary
public Object getValue(String name) Implements org.springframework.web.util.UriComponents.UriTemplateVariables.getValue. Doc from org.springframework.web.util.UriComponents.UriTemplateVariables.getValue. Get the value for the given URI variable name. If the value is `null`, an empty String is expanded. If the value is `SKIP_VALUE`, the URI variable is not expanded. Parameters name:String the variable name Returns:Object the variable value, possibly `null` or `SKIP_VALUE` Annotations @Override @Nullable

public Object getValue(String name)

Implements org.springframework.web.util.UriComponents.UriTemplateVariables.getValue.

Doc from org.springframework.web.util.UriComponents.UriTemplateVariables.getValue.

Get the value for the given URI variable name. If the value is null, an empty String is expanded. If the value is SKIP_VALUE, the URI variable is not expanded.

Parameters

name:String: the variable name

Returns:Object

the variable value, possibly null or SKIP_VALUE

Annotations

@Override
@Nullable

org.springframework.web.util back to summary

public Interface UriComponents.UriTemplateVariables

Known Direct Implementers: org.springframework.web.util.UriComponents.MapTemplateVariables, org.springframework.web.util.UriComponents.VarArgsTemplateVariables, org.springframework.web.util.HierarchicalUriComponents.QueryUriTemplateVariables

Defines the contract for URI Template variables.

See Also: HierarchicalUriComponents#expand

Field Summary

Modifier and Type	Field and Description
public static final Object	SKIP_VALUE Constant for a value that indicates a URI variable name should be ignored and left as is.

Method Summary

Modifier and Type	Method and Description
public Object	Returns: the variable value, possibly `null` or `SKIP_VALUE` getValue(String the variable name name) Get the value for the given URI variable name.

Field Detail

SKIP_VALUE	back to summary
public static final Object SKIP_VALUE Constant for a value that indicates a URI variable name should be ignored and left as is. This is useful for partial expanding of some but not all URI variables.

Method Detail

getValue back to summary

getValue	back to summary
public Object getValue(String name) Get the value for the given URI variable name. If the value is `null`, an empty String is expanded. If the value is `SKIP_VALUE`, the URI variable is not expanded. Parameters name:String the variable name Returns:Object the variable value, possibly `null` or `SKIP_VALUE` Annotations @Nullable

public Object getValue(String name)

Get the value for the given URI variable name. If the value is null, an empty String is expanded. If the value is SKIP_VALUE, the URI variable is not expanded.

Parameters

name:String: the variable name

Returns:Object

the variable value, possibly null or SKIP_VALUE

Annotations

@Nullable

org.springframework.web.util back to summary

private Class UriComponents.VarArgsTemplateVariables

Class Inheritance

extends Object
implements UriTemplateVariables

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

All Implemented Interfaces

org.springframework.web.util.UriComponents.UriTemplateVariables

URI template variables backed by a variable argument array.

Field Summary

Modifier and Type	Field and Description
private final Iterator<Object>	valueIterator

Constructor Summary

Access	Constructor and Description
public	VarArgsTemplateVariables(Object... uriVariableValues)

Method Summary

Modifier and Type	Method and Description
public Object	getValue(String the variable name name) Implements org.springframework.web.util.UriComponents.UriTemplateVariables.getValue. Get the value for the given URI variable name.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

valueIterator	back to summary
private final Iterator<Object> valueIterator

Constructor Detail

VarArgsTemplateVariables	back to summary
public VarArgsTemplateVariables(Object... uriVariableValues)

Method Detail

getValue back to summary

getValue	back to summary
public Object getValue(String name) Implements org.springframework.web.util.UriComponents.UriTemplateVariables.getValue. Doc from org.springframework.web.util.UriComponents.UriTemplateVariables.getValue. Get the value for the given URI variable name. If the value is `null`, an empty String is expanded. If the value is `SKIP_VALUE`, the URI variable is not expanded. Parameters name:String the variable name Returns:Object the variable value, possibly `null` or `SKIP_VALUE` Annotations @Override @Nullable

public Object getValue(String name)

Implements org.springframework.web.util.UriComponents.UriTemplateVariables.getValue.

Doc from org.springframework.web.util.UriComponents.UriTemplateVariables.getValue.

Get the value for the given URI variable name. If the value is null, an empty String is expanded. If the value is SKIP_VALUE, the URI variable is not expanded.

Parameters

name:String: the variable name

Returns:Object

the variable value, possibly null or SKIP_VALUE

Annotations

@Override
@Nullable

public abstract Class UriComponents

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class UriComponents.MapTemplateVariables

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface UriComponents.UriTemplateVariables

Field Summary

Method Summary

Field Detail

Method Detail

private Class UriComponents.VarArgsTemplateVariables

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail