程序包 cn.taketoday.web.util

类 DefaultUriBuilderFactory

java.lang.Object

cn.taketoday.web.util.DefaultUriBuilderFactory

所有已实现的接口:

UriBuilderFactory, UriTemplateHandler

public class DefaultUriBuilderFactory
extends Object
implements UriBuilderFactory

UriBuilderFactory that relies on UriComponentsBuilder for the actual building of the URI.

Provides options to create UriBuilder instances with a common base URI, alternative encoding mode strategies, among others.

从以下版本开始:

4.0

作者:

Rossen Stoyanchev

另请参阅:

• UriComponentsBuilder

嵌套类概要

嵌套类

修饰符和类型	类	说明
private class	DefaultUriBuilderFactory.DefaultUriBuilder	DefaultUriBuilderFactory specific implementation of UriBuilder.
static enum	DefaultUriBuilderFactory.EncodingMode	Enum to represent multiple URI encoding strategies.

字段概要

字段

修饰符和类型	字段	说明
private final UriComponentsBuilder	baseUri
private final Map<String,Object>	defaultUriVariables
private DefaultUriBuilderFactory.EncodingMode	encodingMode
private boolean	parsePath

构造器概要

构造器

构造器	说明
DefaultUriBuilderFactory()	Default constructor without a base URI.
DefaultUriBuilderFactory(UriComponentsBuilder baseUri)	Variant of DefaultUriBuilderFactory(String) with a UriComponentsBuilder.
DefaultUriBuilderFactory(String baseUriTemplate)	Constructor with a base URI.

方法概要

修饰符和类型	方法	说明
UriBuilder	builder()	Create a URI builder with default settings.
URI	expand(String uriTemplate, Object... uriVars)	Expand the given URI template with an array of URI variables.
URI	expand(String uriTemplate, Map<String,?> uriVars)	Expand the given URI template with a map of URI variables.
Map<String,?>	getDefaultUriVariables()	Return the configured default URI variable values.
DefaultUriBuilderFactory.EncodingMode	getEncodingMode()	Return the configured encoding mode.
void	setDefaultUriVariables(Map<String,?> defaultUriVariables)	Provide default URI variable values to use when expanding URI templates with a Map of variables.
void	setEncodingMode(DefaultUriBuilderFactory.EncodingMode encodingMode)	Set the encoding mode to use.
void	setParsePath(boolean parsePath)	Whether to parse the input path into path segments if the encoding mode is set to EncodingMode.URI_COMPONENT, which ensures that URI variables in the path are encoded according to path segment rules and for example a '/' is encoded.
boolean	shouldParsePath()	Whether to parse the path into path segments if the encoding mode is set to EncodingMode.URI_COMPONENT.
UriBuilder	uriString(String uriTemplate)	Initialize a builder with the given URI template.

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

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

字段详细资料

baseUri

@Nullable
private final UriComponentsBuilder baseUri

encodingMode

private DefaultUriBuilderFactory.EncodingMode encodingMode

defaultUriVariables

private final Map<String,Object> defaultUriVariables

parsePath

private boolean parsePath

构造器详细资料

DefaultUriBuilderFactory

public DefaultUriBuilderFactory()

Default constructor without a base URI.

The target address must be specified on each UriBuilder.

DefaultUriBuilderFactory

public DefaultUriBuilderFactory(String baseUriTemplate)

Constructor with a base URI.

The given URI template is parsed via UriComponentsBuilder.fromUriString(java.lang.String) and then applied as a base URI to every UriBuilder via UriComponentsBuilder.uriComponents(cn.taketoday.web.util.UriComponents) unless the UriBuilder itself was created with a URI template that already has a target address.

参数:

baseUriTemplate - the URI template to use a base URL

DefaultUriBuilderFactory

public DefaultUriBuilderFactory(UriComponentsBuilder baseUri)

Variant of DefaultUriBuilderFactory(String) with a UriComponentsBuilder.

方法详细资料

setEncodingMode

public void setEncodingMode(DefaultUriBuilderFactory.EncodingMode encodingMode)

Set the encoding mode to use.

By default this is set to EncodingMode.TEMPLATE_AND_VALUES.

Note: Prior to 5.1 the default was EncodingMode.URI_COMPONENT therefore the WebClient RestTemplate have switched their default behavior.

参数:

encodingMode - the encoding mode to use

getEncodingMode

public DefaultUriBuilderFactory.EncodingMode getEncodingMode()

Return the configured encoding mode.

setDefaultUriVariables

public void setDefaultUriVariables(@Nullable
 Map<String,?> defaultUriVariables)

Provide default URI variable values to use when expanding URI templates with a Map of variables.

参数:

defaultUriVariables - default URI variable values

getDefaultUriVariables

public Map<String,?> getDefaultUriVariables()

Return the configured default URI variable values.

setParsePath

public void setParsePath(boolean parsePath)

Whether to parse the input path into path segments if the encoding mode is set to EncodingMode.URI_COMPONENT, which ensures that URI variables in the path are encoded according to path segment rules and for example a '/' is encoded.

By default this is set to true.

参数:

parsePath - whether to parse the path into path segments

shouldParsePath

public boolean shouldParsePath()

Whether to parse the path into path segments if the encoding mode is set to EncodingMode.URI_COMPONENT.

expand

public URI expand(String uriTemplate,
 Map<String,?> uriVars)

从接口复制的说明: UriTemplateHandler

Expand the given URI template with a map of URI variables.

指定者:

expand 在接口中 UriTemplateHandler

参数:

uriTemplate - the URI template

uriVars - variable values

返回:

the created URI instance

expand

public URI expand(String uriTemplate,
 Object... uriVars)

从接口复制的说明: UriTemplateHandler

Expand the given URI template with an array of URI variables.

指定者:

expand 在接口中 UriTemplateHandler

参数:

uriTemplate - the URI template

uriVars - variable values

返回:

the created URI instance

uriString

public UriBuilder uriString(String uriTemplate)

从接口复制的说明: UriBuilderFactory

Initialize a builder with the given URI template.

指定者:

uriString 在接口中 UriBuilderFactory

参数:

uriTemplate - the URI template to use

返回:

the builder instance

builder

public UriBuilder builder()

从接口复制的说明: UriBuilderFactory

Create a URI builder with default settings.

指定者:

builder 在接口中 UriBuilderFactory

返回:

the builder instance