org.springframework.web.util

Class OpaqueUriComponents

java.lang.Object

org.springframework.web.util.UriComponents

org.springframework.web.util.OpaqueUriComponents

All Implemented Interfaces:

java.io.Serializable

final class OpaqueUriComponents
extends UriComponents

Extension of UriComponents for opaque URIs.

Since:

3.2

Author:

Arjen Poutsma, Phillip Webb

See Also:

Hierarchical vs Opaque URIs

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.web.util.UriComponents

UriComponents.UriTemplateVariables

Field Summary

Fields

Modifier and Type	Field and Description
private static MultiValueMap<java.lang.String,java.lang.String>	QUERY_PARAMS_NONE
private java.lang.String	ssp

Constructor Summary

Constructors

Constructor and Description
OpaqueUriComponents(java.lang.String scheme, java.lang.String schemeSpecificPart, java.lang.String fragment)

Method Summary

Modifier and Type	Method and Description
protected void	copyToUriComponentsBuilder(UriComponentsBuilder builder) Set all components of the given UriComponentsBuilder.
UriComponents	encode(java.lang.String encoding) Encode all URI components using their specific encoding rules, and returns the result as a new UriComponents instance.
boolean	equals(java.lang.Object obj)
protected UriComponents	expandInternal(UriComponents.UriTemplateVariables uriVariables) Replace all URI template variables with the values from the given UriComponents.UriTemplateVariables
java.lang.String	getHost() Returns the host.
java.lang.String	getPath() Returns the path.
java.util.List<java.lang.String>	getPathSegments() Returns the list of path segments.
int	getPort() Returns the port.
java.lang.String	getQuery() Returns the query.
MultiValueMap<java.lang.String,java.lang.String>	getQueryParams() Returns the map of query parameters.
java.lang.String	getSchemeSpecificPart() Returns the scheme specific part.
java.lang.String	getUserInfo() Returns the user info.
int	hashCode()
UriComponents	normalize() Normalize the path removing sequences like "path/..".
java.net.URI	toUri() Return a URI from this UriComponents instance.
java.lang.String	toUriString() Return a URI string from this UriComponents instance.

Methods inherited from class org.springframework.web.util.UriComponents

encode, expand, expand, expand, expandUriComponent, getFragment, getScheme, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

QUERY_PARAMS_NONE

private static final MultiValueMap<java.lang.String,java.lang.String> QUERY_PARAMS_NONE

ssp

private final java.lang.String ssp

Constructor Detail

OpaqueUriComponents

OpaqueUriComponents(java.lang.String scheme,
                    java.lang.String schemeSpecificPart,
                    java.lang.String fragment)

Method Detail

getSchemeSpecificPart

public java.lang.String getSchemeSpecificPart()

Description copied from class: UriComponents

Returns the scheme specific part. Can be null.

Specified by:

getSchemeSpecificPart in class UriComponents

getUserInfo

public java.lang.String getUserInfo()

Description copied from class: UriComponents

Returns the user info. Can be null.

Specified by:

getUserInfo in class UriComponents

getHost

public java.lang.String getHost()

Description copied from class: UriComponents

Returns the host. Can be null.

Specified by:

getHost in class UriComponents

getPort

public int getPort()

Description copied from class: UriComponents

Returns the port. Returns -1 if no port has been set.

Specified by:

getPort in class UriComponents

getPath

public java.lang.String getPath()

Description copied from class: UriComponents

Returns the path. Can be null.

Specified by:

getPath in class UriComponents

getPathSegments

public java.util.List<java.lang.String> getPathSegments()

Description copied from class: UriComponents

Returns the list of path segments. Empty if no path has been set.

Specified by:

getPathSegments in class UriComponents

getQuery

public java.lang.String getQuery()

Description copied from class: UriComponents

Returns the query. Can be null.

Specified by:

getQuery in class UriComponents

getQueryParams

public MultiValueMap<java.lang.String,java.lang.String> getQueryParams()

Description copied from class: UriComponents

Returns the map of query parameters. Empty if no query has been set.

Specified by:

getQueryParams in class UriComponents

encode

public UriComponents encode(java.lang.String encoding)
                     throws java.io.UnsupportedEncodingException

Description copied from class: UriComponents

Encode all URI components using their specific encoding rules, and returns the result as a new UriComponents instance.

Specified by:

encode in class UriComponents

Parameters:

encoding - the encoding of the values contained in this map

Returns:

the encoded URI components

Throws:

java.io.UnsupportedEncodingException - if the given encoding is not supported

expandInternal

protected UriComponents expandInternal(UriComponents.UriTemplateVariables uriVariables)

Description copied from class: UriComponents

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

Specified by:

expandInternal in class UriComponents

Parameters:

uriVariables - URI template values

Returns:

the expanded uri components

normalize

public UriComponents normalize()

Description copied from class: UriComponents

Normalize the path removing sequences like "path/..".

Specified by:

normalize in class UriComponents

See Also:

StringUtils.cleanPath(String)

toUriString

public java.lang.String toUriString()

Description copied from class: UriComponents

Return a URI string from this UriComponents instance.

Specified by:

toUriString in class UriComponents

toUri

public java.net.URI toUri()

Description copied from class: UriComponents

Return a URI from this UriComponents instance.

Specified by:

toUri in class UriComponents

copyToUriComponentsBuilder

protected void copyToUriComponentsBuilder(UriComponentsBuilder builder)

Description copied from class: UriComponents

Set all components of the given UriComponentsBuilder.

Specified by:

copyToUriComponentsBuilder in class UriComponents

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object