程序包 cn.taketoday.web.util

类 HierarchicalUriComponents

java.lang.Object

cn.taketoday.web.util.UriComponents

cn.taketoday.web.util.HierarchicalUriComponents

所有已实现的接口:

Serializable

final class HierarchicalUriComponents
extends UriComponents

Extension of UriComponents for hierarchical URIs.

从以下版本开始:

4.0

作者:

Arjen Poutsma, Juergen Hoeller, Rossen Stoyanchev, Phillip Webb, Sam Brannen

另请参阅:

• Hierarchical URIs

嵌套类概要

嵌套类

修饰符和类型	类	说明
private static enum	HierarchicalUriComponents.EncodeState
(专用程序包) static final class	HierarchicalUriComponents.FullPathComponent	Represents a path backed by a String.
(专用程序包) static interface	HierarchicalUriComponents.PathComponent	Defines the contract for path (segments).
(专用程序包) static final class	HierarchicalUriComponents.PathComponentComposite	Represents a collection of PathComponents.
(专用程序包) static final class	HierarchicalUriComponents.PathSegmentComponent	Represents a path backed by a String list (i.e. path segments).
private static final record	HierarchicalUriComponents.QueryUriTemplateVariables
(专用程序包) static enum	HierarchicalUriComponents.Type	Enumeration used to identify the allowed characters per URI component.
private static class	HierarchicalUriComponents.UriTemplateEncoder

从类继承的嵌套类/接口 cn.taketoday.web.util.UriComponents

UriComponents.UriTemplateVariables

字段概要

字段

修饰符和类型	字段	说明
private static final cn.taketoday.util.MultiValueMap<String,String>	EMPTY_QUERY_PARAMS
private final HierarchicalUriComponents.EncodeState	encodeState
private final String	host
(专用程序包) static final HierarchicalUriComponents.PathComponent	NULL_PATH_COMPONENT	Represents an empty path.
private final HierarchicalUriComponents.PathComponent	path
private static final char	PATH_DELIMITER
private static final String	PATH_DELIMITER_STRING
private final String	port
private final cn.taketoday.util.MultiValueMap<String,String>	queryParams
private final String	userInfo
private UnaryOperator<String>	variableEncoder

构造器概要

构造器

限定符	构造器	说明
(专用程序包)	HierarchicalUriComponents(String scheme, String fragment, String userInfo, String host, String port, HierarchicalUriComponents.PathComponent path, cn.taketoday.util.MultiValueMap<String,String> query, boolean encoded)	Package-private constructor.
private	HierarchicalUriComponents(String scheme, String fragment, String userInfo, String host, String port, HierarchicalUriComponents.PathComponent path, cn.taketoday.util.MultiValueMap<String,String> queryParams, HierarchicalUriComponents.EncodeState encodeState, UnaryOperator<String> variableEncoder)

方法概要

修饰符和类型	方法	说明
protected void	copyToUriComponentsBuilder(UriComponentsBuilder builder)	Set all components of the given UriComponentsBuilder.
HierarchicalUriComponents	encode(Charset charset)	A variant of UriComponents.encode() with a charset other than "UTF-8".
private cn.taketoday.util.MultiValueMap<String,String>	encodeQueryParams(BiFunction<String,HierarchicalUriComponents.Type,String> encoder)
(专用程序包) HierarchicalUriComponents	encodeTemplate(Charset charset)	Identical to UriComponents.encode() but skipping over URI variable placeholders.
(专用程序包) static String	encodeUriComponent(String source, String encoding, HierarchicalUriComponents.Type type)	Encode the given source into an encoded String using the rules specified by the given component and with the given options.
(专用程序包) static String	encodeUriComponent(String source, Charset charset, HierarchicalUriComponents.Type type)	Encode the given source into an encoded String using the rules specified by the given component and with the given options.
boolean	equals(Object other)
protected HierarchicalUriComponents	expandInternal(UriComponents.UriTemplateVariables uriVariables)	Replace all URI template variables with the values from the given UriComponents.UriTemplateVariables.
private cn.taketoday.util.MultiValueMap<String,String>	expandQueryParams(UriComponents.UriTemplateVariables variables)
String	getHost()	Return the host.
private HierarchicalUriComponents.Type	getHostType()
String	getPath()	Return the path.
List<String>	getPathSegments()	Return the list of path segments.
int	getPort()	Return the port.
String	getQuery()	Return the query.
cn.taketoday.util.MultiValueMap<String,String>	getQueryParams()	Return the map of query parameters.
String	getSchemeSpecificPart()	Return the scheme specific part.
String	getUserInfo()	Return the user info.
int	hashCode()
UriComponents	normalize()	Normalize the path removing sequences like "path/..".
URI	toUri()	Create a URI from this instance as follows:
String	toUriString()	Concatenate all URI components to return the fully formed URI String.
private void	verify()	Check if any of the URI components contain any illegal characters.
private static void	verifyUriComponent(String source, HierarchicalUriComponents.Type type)

从类继承的方法 cn.taketoday.web.util.UriComponents

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

从类继承的方法 java.lang.Object

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

字段详细资料

PATH_DELIMITER

private static final char PATH_DELIMITER

另请参阅:

• 常量字段值

PATH_DELIMITER_STRING

private static final String PATH_DELIMITER_STRING

EMPTY_QUERY_PARAMS

private static final cn.taketoday.util.MultiValueMap<String,String> EMPTY_QUERY_PARAMS

NULL_PATH_COMPONENT

static final HierarchicalUriComponents.PathComponent NULL_PATH_COMPONENT

Represents an empty path.

userInfo

@Nullable
private final String userInfo

host

@Nullable
private final String host

port

@Nullable
private final String port

path

private final HierarchicalUriComponents.PathComponent path

queryParams

private final cn.taketoday.util.MultiValueMap<String,String> queryParams

encodeState

private final HierarchicalUriComponents.EncodeState encodeState

variableEncoder

@Nullable
private UnaryOperator<String> variableEncoder

构造器详细资料

HierarchicalUriComponents

HierarchicalUriComponents(@Nullable
 String scheme,
 @Nullable
 String fragment,
 @Nullable
 String userInfo,
 @Nullable
 String host,
 @Nullable
 String port,
 @Nullable
 HierarchicalUriComponents.PathComponent path,
 @Nullable
 cn.taketoday.util.MultiValueMap<String,String> query,
 boolean encoded)

Package-private constructor. All arguments are optional, and can be null.

参数:

scheme - the scheme

userInfo - the user info

host - the host

port - the port

path - the path

query - the query parameters

fragment - the fragment

encoded - whether the components are already encoded

HierarchicalUriComponents

private HierarchicalUriComponents(@Nullable
 String scheme,
 @Nullable
 String fragment,
 @Nullable
 String userInfo,
 @Nullable
 String host,
 @Nullable
 String port,
 HierarchicalUriComponents.PathComponent path,
 cn.taketoday.util.MultiValueMap<String,String> queryParams,
 HierarchicalUriComponents.EncodeState encodeState,
 @Nullable
 UnaryOperator<String> variableEncoder)

方法详细资料

getSchemeSpecificPart

@Nullable
public String getSchemeSpecificPart()

从类复制的说明: UriComponents

Return the scheme specific part. Can be null.

指定者:

getSchemeSpecificPart 在类中 UriComponents

getUserInfo

@Nullable
public String getUserInfo()

从类复制的说明: UriComponents

Return the user info. Can be null.

指定者:

getUserInfo 在类中 UriComponents

getHost

@Nullable
public String getHost()

从类复制的说明: UriComponents

Return the host. Can be null.

指定者:

getHost 在类中 UriComponents

getPort

public int getPort()

从类复制的说明: UriComponents

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

指定者:

getPort 在类中 UriComponents

getPath

@NonNull
public String getPath()

从类复制的说明: UriComponents

Return the path. Can be null.

指定者:

getPath 在类中 UriComponents

getPathSegments

public List<String> getPathSegments()

从类复制的说明: UriComponents

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

指定者:

getPathSegments 在类中 UriComponents

getQuery

@Nullable
public String getQuery()

从类复制的说明: UriComponents

Return the query. Can be null.

指定者:

getQuery 在类中 UriComponents

getQueryParams

public cn.taketoday.util.MultiValueMap<String,String> getQueryParams()

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

指定者:

getQueryParams 在类中 UriComponents

encodeTemplate

HierarchicalUriComponents encodeTemplate(Charset charset)

Identical to UriComponents.encode() but skipping over URI variable placeholders. Also variableEncoder is initialized with the given charset for use later when URI variables are expanded.

encode

public HierarchicalUriComponents encode(Charset charset)

从类复制的说明: UriComponents

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

指定者:

encode 在类中 UriComponents

参数:

charset - the charset to use for encoding

另请参阅:

• UriComponentsBuilder.encode(Charset)

encodeQueryParams

private cn.taketoday.util.MultiValueMap<String,String> encodeQueryParams(BiFunction<String,HierarchicalUriComponents.Type,String> encoder)

encodeUriComponent

static String encodeUriComponent(String source,
 String encoding,
 HierarchicalUriComponents.Type type)

Encode the given source into an encoded String using the rules specified by the given component and with the given options.

参数:

source - the source String

encoding - the encoding of the source String

type - the URI component for the source

返回:

the encoded URI

抛出:

IllegalArgumentException - when the given value is not a valid URI component

encodeUriComponent

static String encodeUriComponent(String source,
 Charset charset,
 HierarchicalUriComponents.Type type)

Encode the given source into an encoded String using the rules specified by the given component and with the given options.

参数:

source - the source String

charset - the encoding of the source String

type - the URI component for the source

返回:

the encoded URI

抛出:

IllegalArgumentException - when the given value is not a valid URI component

getHostType

private HierarchicalUriComponents.Type getHostType()

verify

private void verify()

Check if any of the URI components contain any illegal characters.

抛出:

IllegalArgumentException - if any component has illegal characters

verifyUriComponent

private static void verifyUriComponent(@Nullable
 String source,
 HierarchicalUriComponents.Type type)

expandInternal

protected HierarchicalUriComponents expandInternal(UriComponents.UriTemplateVariables uriVariables)

从类复制的说明: UriComponents

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

指定者:

expandInternal 在类中 UriComponents

参数:

uriVariables - the URI template values

返回:

the expanded URI components

expandQueryParams

private cn.taketoday.util.MultiValueMap<String,String> expandQueryParams(UriComponents.UriTemplateVariables variables)

normalize

public UriComponents normalize()

从类复制的说明: UriComponents

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

指定者:

normalize 在类中 UriComponents

另请参阅:

• StringUtils.cleanPath(String)

toUriString

public String toUriString()

从类复制的说明: UriComponents

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 UriComponents.encode().

指定者:

toUriString 在类中 UriComponents

toUri

public URI toUri()

从类复制的说明: UriComponents

Create a URI from this instance as follows:

If the current instance is encoded, form the full URI String via UriComponents.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.

指定者:

toUri 在类中 UriComponents

copyToUriComponentsBuilder

protected void copyToUriComponentsBuilder(UriComponentsBuilder builder)

从类复制的说明: UriComponents

Set all components of the given UriComponentsBuilder.

指定者:

copyToUriComponentsBuilder 在类中 UriComponents

equals

public boolean equals(@Nullable
 Object other)

覆盖:

equals 在类中 Object

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object