程序包 cn.taketoday.web.util

类 DefaultUriBuilderFactory.DefaultUriBuilder

java.lang.Object

cn.taketoday.web.util.DefaultUriBuilderFactory.DefaultUriBuilder

所有已实现的接口:

UriBuilder

封闭类:

DefaultUriBuilderFactory

private class DefaultUriBuilderFactory.DefaultUriBuilder
extends Object
implements UriBuilder

DefaultUriBuilderFactory specific implementation of UriBuilder.

字段概要

字段

修饰符和类型	字段	说明
private final UriComponentsBuilder	uriComponentsBuilder

构造器概要

构造器

构造器	说明
DefaultUriBuilder(String uriTemplate)

方法概要

修饰符和类型	方法	说明
URI	build(Object... uriVars)	Build a URI instance and replaces URI template variables with the values from an array.
URI	build(Map<String,?> uriVars)	Build a URI instance and replaces URI template variables with the values from a map.
private URI	createUri(UriComponents uric)
DefaultUriBuilderFactory.DefaultUriBuilder	fragment(String fragment)	Set the URI fragment.
DefaultUriBuilderFactory.DefaultUriBuilder	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.
private UriComponentsBuilder	initUriComponentsBuilder(String uriTemplate)
private void	parsePathIfNecessary(UriComponentsBuilder result)
DefaultUriBuilderFactory.DefaultUriBuilder	path(String path)	Append to the path of this builder.
DefaultUriBuilderFactory.DefaultUriBuilder	pathSegment(String... pathSegments)	Append to the path using path segments.
DefaultUriBuilderFactory.DefaultUriBuilder	port(int port)	Set the URI port.
DefaultUriBuilderFactory.DefaultUriBuilder	port(String port)	Set the URI port .
DefaultUriBuilderFactory.DefaultUriBuilder	query(String query)	Parse the given query string into query parameters where parameters are separated with '&' and their values, if any, with '='.
DefaultUriBuilderFactory.DefaultUriBuilder	queryParam(String name, Object... values)	Append the given query parameter.
DefaultUriBuilderFactory.DefaultUriBuilder	queryParam(String name, Collection<?> values)	Variant of UriBuilder.queryParam(String, Object...) with a Collection.
DefaultUriBuilderFactory.DefaultUriBuilder	queryParamIfPresent(String name, Optional<?> value)	Delegates to either UriBuilder.queryParam(String, Object...) or UriBuilder.queryParam(String, Collection) if the given Optional has a value, or else if it is empty, no query parameter is added at all.
DefaultUriBuilderFactory.DefaultUriBuilder	queryParams(cn.taketoday.util.MultiValueMap<String,String> params)	Add multiple query parameters and values.
DefaultUriBuilderFactory.DefaultUriBuilder	replacePath(String path)	Override the current path.
DefaultUriBuilderFactory.DefaultUriBuilder	replaceQuery(String query)	Clear existing query parameters and then delegate to UriBuilder.query(String).
DefaultUriBuilderFactory.DefaultUriBuilder	replaceQueryParam(String name, Object... values)	Set the query parameter values replacing existing values, or if no values are given, the query parameter is removed.
DefaultUriBuilderFactory.DefaultUriBuilder	replaceQueryParam(String name, Collection<?> values)	Variant of UriBuilder.replaceQueryParam(String, Object...) with a Collection.
DefaultUriBuilderFactory.DefaultUriBuilder	replaceQueryParams(cn.taketoday.util.MultiValueMap<String,String> params)	Set the query parameter values after removing all existing ones.
DefaultUriBuilderFactory.DefaultUriBuilder	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.
DefaultUriBuilderFactory.DefaultUriBuilder	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.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

uriComponentsBuilder

private final UriComponentsBuilder uriComponentsBuilder

构造器详细资料

DefaultUriBuilder

public DefaultUriBuilder(String uriTemplate)

方法详细资料

initUriComponentsBuilder

private UriComponentsBuilder initUriComponentsBuilder(String uriTemplate)

parsePathIfNecessary

private void parsePathIfNecessary(UriComponentsBuilder result)

scheme

public DefaultUriBuilderFactory.DefaultUriBuilder scheme(@Nullable
 String scheme)

从接口复制的说明: UriBuilder

Set the URI scheme which may contain URI template variables, and may also be null to clear the scheme of this builder.

指定者:

scheme 在接口中 UriBuilder

参数:

scheme - the URI scheme

userInfo

public DefaultUriBuilderFactory.DefaultUriBuilder userInfo(@Nullable
 String userInfo)

从接口复制的说明: UriBuilder

Set the URI user info which may contain URI template variables, and may also be null to clear the user info of this builder.

指定者:

userInfo 在接口中 UriBuilder

参数:

userInfo - the URI user info

host

public DefaultUriBuilderFactory.DefaultUriBuilder host(@Nullable
 String host)

从接口复制的说明: UriBuilder

Set the URI host which may contain URI template variables, and may also be null to clear the host of this builder.

指定者:

host 在接口中 UriBuilder

参数:

host - the URI host

port

public DefaultUriBuilderFactory.DefaultUriBuilder port(int port)

从接口复制的说明: UriBuilder

Set the URI port. Passing -1 will clear the port of this builder.

指定者:

port 在接口中 UriBuilder

参数:

port - the URI port

port

public DefaultUriBuilderFactory.DefaultUriBuilder port(@Nullable
 String port)

从接口复制的说明: UriBuilder

Set the URI port . Use this method only when the port needs to be parameterized with a URI variable. Otherwise use UriBuilder.port(int). Passing null will clear the port of this builder.

指定者:

port 在接口中 UriBuilder

参数:

port - the URI port

path

public DefaultUriBuilderFactory.DefaultUriBuilder path(String path)

从接口复制的说明: UriBuilder

Append to the path of this builder.

The given value is appended as-is to previous path values without inserting any additional slashes. For example:

 builder.path("/first-").path("value/").path("/{id}").build("123")

 // Results is "/first-value/123"
 

By contrast pathSegment does insert slashes between individual path segments. For example:

 builder.pathSegment("first-value", "second-value").path("/")

 // Results is "/first-value/second-value/"
 

The resulting full path is normalized to eliminate duplicate slashes.

Note: When inserting a URI variable value that contains slashes in a path, whether those are encoded depends on the configured encoding mode. For more details, see UriComponentsBuilder.encode(), or otherwise if building URIs indirectly via WebClient or RestTemplate, see its encodingMode. Also see the URI Encoding section of the reference docs.

指定者:

path 在接口中 UriBuilder

参数:

path - the URI path

replacePath

public DefaultUriBuilderFactory.DefaultUriBuilder replacePath(@Nullable
 String path)

从接口复制的说明: UriBuilder

Override the current path.

指定者:

replacePath 在接口中 UriBuilder

参数:

path - the URI path, or null for an empty path

pathSegment

public DefaultUriBuilderFactory.DefaultUriBuilder pathSegment(String... pathSegments)

从接口复制的说明: UriBuilder

Append to the path using path segments. For example:

 builder.pathSegment("first-value", "second-value", "{id}").build("123")

 // Results is "/first-value/second-value/123"
 

If slashes are present in a path segment, they are encoded:

 builder.pathSegment("ba/z", "{id}").build("a/b")

 // Results is "/ba%2Fz/a%2Fb"
 

To insert a trailing slash, use the UriBuilder.path(java.lang.String) builder method:

 builder.pathSegment("first-value", "second-value").path("/")

 // Results is "/first-value/second-value/"
 

Empty path segments are ignored and therefore duplicate slashes do not appear in the resulting full path.

指定者:

pathSegment 在接口中 UriBuilder

参数:

pathSegments - the URI path segments

query

public DefaultUriBuilderFactory.DefaultUriBuilder query(String query)

从接口复制的说明: UriBuilder

Parse the given query string into query parameters where parameters are separated with '&' and their values, if any, with '='. The query may contain URI template variables.

Note: please, review the Javadoc of UriBuilder.queryParam(String, Object...) for further notes on the treatment and encoding of individual query parameters.

指定者:

query 在接口中 UriBuilder

参数:

query - the query string

replaceQuery

public DefaultUriBuilderFactory.DefaultUriBuilder replaceQuery(@Nullable
 String query)

从接口复制的说明: UriBuilder

Clear existing query parameters and then delegate to UriBuilder.query(String).

Note: please, review the Javadoc of UriBuilder.queryParam(String, Object...) for further notes on the treatment and encoding of individual query parameters.

指定者:

replaceQuery 在接口中 UriBuilder

参数:

query - the query string; a null value removes all query parameters.

queryParam

public DefaultUriBuilderFactory.DefaultUriBuilder queryParam(String name,
 Object... values)

从接口复制的说明: UriBuilder

Append the given query parameter. Both the parameter name and values may contain URI template variables to be expanded later from values. If no values are given, the resulting URI will contain the query parameter name only, e.g. "?foo" instead of "?foo=bar".

Note: encoding, if applied, will only encode characters that are illegal in a query parameter name or value such as "=" or "&". All others that are legal as per syntax rules in RFC 3986 are not encoded. This includes "+" which sometimes needs to be encoded to avoid its interpretation as an encoded space. Stricter encoding may be applied by using a URI template variable along with stricter encoding on variable values. For more details please read the "URI Encoding" section of the Framework reference.

指定者:

queryParam 在接口中 UriBuilder

参数:

name - the query parameter name

values - the query parameter values

另请参阅:

• UriBuilder.queryParam(String, Collection)

queryParam

public DefaultUriBuilderFactory.DefaultUriBuilder queryParam(String name,
 @Nullable
 Collection<?> values)

从接口复制的说明: UriBuilder

Variant of UriBuilder.queryParam(String, Object...) with a Collection.

Note: please, review the Javadoc of UriBuilder.queryParam(String, Object...) for further notes on the treatment and encoding of individual query parameters.

指定者:

queryParam 在接口中 UriBuilder

参数:

name - the query parameter name

values - the query parameter values

另请参阅:

• UriBuilder.queryParam(String, Object...)

queryParamIfPresent

public DefaultUriBuilderFactory.DefaultUriBuilder queryParamIfPresent(String name,
 Optional<?> value)

从接口复制的说明: UriBuilder

Delegates to either UriBuilder.queryParam(String, Object...) or UriBuilder.queryParam(String, Collection) if the given Optional has a value, or else if it is empty, no query parameter is added at all.

指定者:

queryParamIfPresent 在接口中 UriBuilder

参数:

name - the query parameter name

value - an Optional, either empty or holding the query parameter value.

queryParams

public DefaultUriBuilderFactory.DefaultUriBuilder queryParams(cn.taketoday.util.MultiValueMap<String,String> params)

从接口复制的说明: UriBuilder

Add multiple query parameters and values.

Note: please, review the Javadoc of UriBuilder.queryParam(String, Object...) for further notes on the treatment and encoding of individual query parameters.

指定者:

queryParams 在接口中 UriBuilder

参数:

params - the params

replaceQueryParam

public DefaultUriBuilderFactory.DefaultUriBuilder replaceQueryParam(String name,
 Object... values)

从接口复制的说明: UriBuilder

Set the query parameter values replacing existing values, or if no values are given, the query parameter is removed.

Note: please, review the Javadoc of UriBuilder.queryParam(String, Object...) for further notes on the treatment and encoding of individual query parameters.

指定者:

replaceQueryParam 在接口中 UriBuilder

参数:

name - the query parameter name

values - the query parameter values

另请参阅:

• UriBuilder.replaceQueryParam(String, Collection)

replaceQueryParam

public DefaultUriBuilderFactory.DefaultUriBuilder replaceQueryParam(String name,
 @Nullable
 Collection<?> values)

从接口复制的说明: UriBuilder

Variant of UriBuilder.replaceQueryParam(String, Object...) with a Collection.

Note: please, review the Javadoc of UriBuilder.queryParam(String, Object...) for further notes on the treatment and encoding of individual query parameters.

指定者:

replaceQueryParam 在接口中 UriBuilder

参数:

name - the query parameter name

values - the query parameter values

另请参阅:

• UriBuilder.replaceQueryParam(String, Object...)

replaceQueryParams

public DefaultUriBuilderFactory.DefaultUriBuilder replaceQueryParams(cn.taketoday.util.MultiValueMap<String,String> params)

从接口复制的说明: UriBuilder

Set the query parameter values after removing all existing ones.

Note: please, review the Javadoc of UriBuilder.queryParam(String, Object...) for further notes on the treatment and encoding of individual query parameters.

指定者:

replaceQueryParams 在接口中 UriBuilder

参数:

params - the query parameter name

fragment

public DefaultUriBuilderFactory.DefaultUriBuilder fragment(@Nullable
 String fragment)

从接口复制的说明: UriBuilder

Set the URI fragment. The given fragment may contain URI template variables, and may also be null to clear the fragment of this builder.

指定者:

fragment 在接口中 UriBuilder

参数:

fragment - the URI fragment

build

public URI build(Map<String,?> uriVars)

从接口复制的说明: UriBuilder

Build a URI instance and replaces URI template variables with the values from a map.

指定者:

build 在接口中 UriBuilder

参数:

uriVars - the map of URI variables

返回:

the URI

build

public URI build(Object... uriVars)

从接口复制的说明: UriBuilder

Build a URI instance and replaces URI template variables with the values from an array.

指定者:

build 在接口中 UriBuilder

参数:

uriVars - the map of URI variables

返回:

the URI

createUri

private URI createUri(UriComponents uric)