程序包 cn.taketoday.web.util

类 AbstractUriTemplateHandler

java.lang.Object

cn.taketoday.web.util.AbstractUriTemplateHandler

所有已实现的接口:

UriTemplateHandler

直接已知子类:

DefaultUriTemplateHandler

public abstract class AbstractUriTemplateHandler
extends Object
implements UriTemplateHandler

Abstract base class for UriTemplateHandler implementations.

Support setBaseUrl(java.lang.String) and setDefaultUriVariables(java.util.Map<java.lang.String, ?>) properties that should be relevant regardless of the URI template expand and encode mechanism used in sub-classes.

从以下版本开始:

4.0

作者:

Rossen Stoyanchev

字段概要

字段

修饰符和类型	字段	说明
private String	baseUrl
private final HashMap<String,Object>	defaultUriVariables

构造器概要

构造器

构造器	说明
AbstractUriTemplateHandler()

方法概要

修饰符和类型	方法	说明
URI	expand(String uriTemplate, Object... uriVariables)	Expand the given URI template with an array of URI variables.
URI	expand(String uriTemplate, Map<String,?> uriVariables)	Expand the given URI template with a map of URI variables.
protected abstract URI	expandInternal(String uriTemplate, Object... uriVariables)	Actually expand and encode the URI template.
protected abstract URI	expandInternal(String uriTemplate, Map<String,?> uriVariables)	Actually expand and encode the URI template.
String	getBaseUrl()	Return the configured base URL.
Map<String,?>	getDefaultUriVariables()	Return a read-only copy of the configured default URI variables.
private URI	insertBaseUrl(URI url)	Insert a base URL (if configured) unless the given URL has a host already.
void	setBaseUrl(String baseUrl)	Configure a base URL to prepend URI templates with.
void	setDefaultUriVariables(Map<String,?> defaultUriVariables)	Configure default URI variable values to use with every expanded URI template.

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

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

字段详细资料

baseUrl

@Nullable
private String baseUrl

defaultUriVariables

private final HashMap<String,Object> defaultUriVariables

构造器详细资料

AbstractUriTemplateHandler

public AbstractUriTemplateHandler()

方法详细资料

setBaseUrl

public void setBaseUrl(@Nullable
 String baseUrl)

Configure a base URL to prepend URI templates with. The base URL must have a scheme and host but may optionally contain a port and a path. The base URL must be fully expanded and encoded which can be done via UriComponentsBuilder.

参数:

baseUrl - the base URL.

getBaseUrl

@Nullable
public String getBaseUrl()

Return the configured base URL.

setDefaultUriVariables

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

Configure default URI variable values to use with every expanded URI template. These default values apply only when expanding with a Map, and not with an array, where the Map supplied to expand(String, Map) can override the default values.

参数:

defaultUriVariables - the default URI variable values

getDefaultUriVariables

public Map<String,?> getDefaultUriVariables()

Return a read-only copy of the configured default URI variables.

expand

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

从接口复制的说明: UriTemplateHandler

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

指定者:

expand 在接口中 UriTemplateHandler

参数:

uriTemplate - the URI template

uriVariables - variable values

返回:

the created URI instance

expand

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

从接口复制的说明: UriTemplateHandler

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

指定者:

expand 在接口中 UriTemplateHandler

参数:

uriTemplate - the URI template

uriVariables - variable values

返回:

the created URI instance

expandInternal

protected abstract URI expandInternal(String uriTemplate,
 Map<String,?> uriVariables)

Actually expand and encode the URI template.

expandInternal

protected abstract URI expandInternal(String uriTemplate,
 Object... uriVariables)

Actually expand and encode the URI template.

insertBaseUrl

private URI insertBaseUrl(URI url)

Insert a base URL (if configured) unless the given URL has a host already.