UriTemplate (com.github.fangjinuo.langx:langx-java:4.3.2 4.3.2 API)

java.lang.Object
- com.jn.langx.util.net.http.jaxrs.UriTemplate

直接已知子类:

PathTemplate
```
public class UriTemplate
extends Object
```
A URI template. Migrate from jersey-common

从以下版本开始:

4.1.0

字段概要

字段
限定符和类型	字段和说明
`static Comparator<UriTemplate>`	`COMPARATOR` Order the templates according to JAX-RS specification.
`static UriTemplate`	`EMPTY` The empty URI template that matches the `null` or empty URI path.

构造器概要

构造器
限定符	构造器和说明
	`UriTemplate(String template)` Construct a new URI template.
`protected`	`UriTemplate(UriTemplateParser templateParser)` Construct a new URI template.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`String`	`createURI(Map<String,String> values)` Create a URI by substituting any template variables for corresponding template values.
`String`	`createURI(String... values)` Create a URI by substituting any template variables for corresponding template values.
`String`	`createURI(String[] values, int offset, int length)` Create a URI by substituting any template variables for corresponding template values.
`static String`	`createURI(String scheme, String authority, String userInfo, String host, String port, String path, String query, String fragment, Map<String,?> values, boolean encode, boolean encodeSlashInPath)` Construct a URI from the component parts each of which may contain template variables.
`static String`	`createURI(String scheme, String authority, String userInfo, String host, String port, String path, String query, String fragment, Object[] values, boolean encode, boolean encodeSlashInPath)` Construct a URI from the component parts each of which may contain template variables.
`static String`	`createURIWithStringValues(String scheme, String authority, String userInfo, String host, String port, String path, String query, String fragment, Map<String,?> values, boolean encode, boolean encodeSlashInPath)` Construct a URI from the component parts each of which may contain template variables.
`static String`	`createURIWithStringValues(String scheme, String authority, String userInfo, String host, String port, String path, String query, String fragment, String[] values, boolean encode, boolean encodeSlashInPath)` Construct a URI from the component parts each of which may contain template variables.
`boolean`	`endsWithSlash()` Check if the URI template ends in a slash (`'/'`).
`boolean`	`equals(Object o)` Equality is calculated from the String of the regular expression generated from the templates.
`int`	`getNumberOfExplicitCharacters()` Get the number of characters in the regular expression not resulting from conversion of template variables.
`int`	`getNumberOfExplicitRegexes()` Get the number of explicit regular expressions declared in the template variables.
`int`	`getNumberOfRegexGroups()` Get the number of regular expression groups
`int`	`getNumberOfTemplateVariables()` Get the number of template variables.
`PatternWithGroups`	`getPattern()` Get the URI pattern.
`String`	`getTemplate()` Get the URI template as a String.
`List<String>`	`getTemplateVariables()` Get the list of template variables for the template.
`int`	`hashCode()` Hash code is calculated from String of the regular expression generated from the template.
`boolean`	`isTemplateVariablePresent(String name)` Ascertain if a template variable is a member of this template.
`boolean`	`match(CharSequence uri, List<String> groupValues)` Match a URI against the template.
`boolean`	`match(CharSequence uri, Map<String,String> templateVariableToValue)` Match a URI against the template.
`static URI`	`normalize(String uri)` Normalize the URI by resolve the dot & dot-dot path segments as described in RFC 3986.
`static URI`	`normalize(URI uri)` Normalize the URI by resolve the dot & dot-dot path segments as described in RFC 3986.
`static URI`	`relativize(URI baseUri, URI refUri)` Relativize URI with respect to a base URI.
`static URI`	`resolve(URI baseUri, String refUri)` Resolve a relative URI reference against a base URI as defined in RFC 3986.
`static URI`	`resolve(URI baseUri, URI refUri)` Resolve a relative URI reference against a base URI as defined in RFC 3986.
`static String`	`resolveTemplateValues(UriComponent.Type type, String template, boolean encode, Map<String,?> _mapValues)` Resolves template variables in the given `template` from `_mapValues`.
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - COMPARATOR
```
public static final Comparator<UriTemplate> COMPARATOR
```
    Order the templates according to JAX-RS specification.
    Sort the set of matching resource classes using the number of characters in the regular expression not resulting from template variables as the primary key, the number of matching groups as a secondary key, and the number of explicit regular expression declarations as the tertiary key.
  - EMPTY
```
public static final UriTemplate EMPTY
```
    The empty URI template that matches the null or empty URI path.
- 构造器详细资料
  - UriTemplate
```
public UriTemplate(String template)
            throws PatternSyntaxException,
                   IllegalArgumentException
```
    Construct a new URI template.
    The template will be parsed to extract template variables.
    
    A specific regular expression will be generated from the template to match URIs according to the template and map template variables to template values.
    
    参数:
    
    template - the template.
    
    抛出:
    
    PatternSyntaxException - if the specified regular expression could not be generated
    
    IllegalArgumentException - if the template is null or an empty string.
  - UriTemplate
```
protected UriTemplate(UriTemplateParser templateParser)
               throws PatternSyntaxException,
                      IllegalArgumentException
```
    Construct a new URI template.
    The template will be parsed to extract template variables.
    A specific regular expression will be generated from the template to match URIs according to the template and map template variables to template values.
    
    参数:
    
    templateParser - the parser to parse the template.
    
    抛出:
    
    PatternSyntaxException - if the specified regular expression could not be generated
    
    IllegalArgumentException - if the template is null or an empty string.
- 方法详细资料
  - resolve
```
public static URI resolve(URI baseUri,
                          String refUri)
```
    Resolve a relative URI reference against a base URI as defined in RFC 3986.
    
    参数:
    
    baseUri - base URI to be used for resolution.
    
    refUri - reference URI string to be resolved against the base URI.
    
    返回:
    
    resolved URI.
    
    抛出:
    
    IllegalArgumentException - If the given string violates the URI specification RFC.
  - resolve
```
public static URI resolve(URI baseUri,
                          URI refUri)
```
    Resolve a relative URI reference against a base URI as defined in RFC 3986.
    
    参数:
    
    baseUri - base URI to be used for resolution.
    
    refUri - reference URI to be resolved against the base URI.
    
    返回:
    
    resolved URI.
  - normalize
```
public static URI normalize(String uri)
```
    Normalize the URI by resolve the dot & dot-dot path segments as described in RFC 3986. This method provides a workaround for issues with URI.normalize() which is not able to properly normalize absolute paths that start with a ".." segment, e.g. "/../a/b" as required by RFC 3986 (according to RFC 3986 the path "/../a/b" should resolve to "/a/b", while URI.normalize() keeps the ".." segment in the URI path.
    
    参数:
    
    uri - the original URI string.
    
    返回:
    
    the URI with dot and dot-dot segments resolved.
    
    抛出:
    
    IllegalArgumentException - If the given string violates the URI specification RFC.
    
    另请参阅:
    
    URI.normalize()
  - normalize
```
public static URI normalize(URI uri)
```
    Normalize the URI by resolve the dot & dot-dot path segments as described in RFC 3986. This method provides a workaround for issues with URI.normalize() which is not able to properly normalize absolute paths that start with a ".." segment, e.g. "/../a/b" as required by RFC 3986 (according to RFC 3986 the path "/../a/b" should resolve to "/a/b", while URI.normalize() keeps the ".." segment in the URI path.
    
    参数:
    
    uri - the original URI.
    
    返回:
    
    the URI with dot and dot-dot segments resolved.
    
    另请参阅:
    
    URI.normalize()
  - relativize
```
public static URI relativize(URI baseUri,
                             URI refUri)
```
    Relativize URI with respect to a base URI. After the relativization is done, dots in paths of both URIs are resolved.
    
    参数:
    
    baseUri - base URI to be used for relativization.
    
    refUri - URI to be relativized.
    
    返回:
    
    relativized URI.
  - getTemplate
```
public final String getTemplate()
```
    Get the URI template as a String.
    
    返回:
    
    the URI template.
  - getPattern
```
public final PatternWithGroups getPattern()
```
    Get the URI pattern.
    
    返回:
    
    the URI pattern.
  - endsWithSlash
```
public final boolean endsWithSlash()
```
    Check if the URI template ends in a slash ('/').
    
    返回:
    
    true if the template ends in a '/', otherwise false.
  - getTemplateVariables
```
public final List<String> getTemplateVariables()
```
    Get the list of template variables for the template.
    
    返回:
    
    the list of template variables.
  - isTemplateVariablePresent
```
public final boolean isTemplateVariablePresent(String name)
```
    Ascertain if a template variable is a member of this template.
    
    参数:
    
    name - name The template variable.
    
    返回:
    
    true if the template variable is a member of the template, otherwise false.
  - getNumberOfExplicitRegexes
```
public final int getNumberOfExplicitRegexes()
```
    Get the number of explicit regular expressions declared in the template variables.
    
    返回:
    
    the number of explicit regular expressions in the template variables.
  - getNumberOfRegexGroups
```
public final int getNumberOfRegexGroups()
```
    Get the number of regular expression groups
    
    返回:
    
    the number of regular expressions groups
  - getNumberOfExplicitCharacters
```
public final int getNumberOfExplicitCharacters()
```
    Get the number of characters in the regular expression not resulting from conversion of template variables.
    
    返回:
    
    the number of explicit characters
  - getNumberOfTemplateVariables
```
public final int getNumberOfTemplateVariables()
```
    Get the number of template variables.
    
    返回:
    
    the number of template variables.
  - match
```
public final boolean match(CharSequence uri,
                           Map<String,String> templateVariableToValue)
                    throws IllegalArgumentException
```
    Match a URI against the template.
    If the URI matches against the pattern then the template variable to value map will be filled with template variables as keys and template values as values.
    
    参数:
    
    uri - the uri to match against the template.
    
    templateVariableToValue - the map where to put template variables (as keys) and template values (as values). The map is cleared before any entries are put.
    
    返回:
    
    true if the URI matches the template, otherwise false.
    
    抛出:
    
    IllegalArgumentException - if the uri or templateVariableToValue is null.
  - match
```
public final boolean match(CharSequence uri,
                           List<String> groupValues)
                    throws IllegalArgumentException
```
    Match a URI against the template.
    If the URI matches against the pattern the capturing group values (if any) will be added to a list passed in as parameter.
    
    参数:
    
    uri - the uri to match against the template.
    
    groupValues - the list to store the values of a pattern's capturing groups is matching is successful. The values are stored in the same order as the pattern's capturing groups.
    
    返回:
    
    true if the URI matches the template, otherwise false.
    
    抛出:
    
    IllegalArgumentException - if the uri or templateVariableToValue is null.
  - createURI
```
public final String createURI(Map<String,String> values)
```
    Create a URI by substituting any template variables for corresponding template values.
    A URI template variable without a value will be substituted by the empty string.
    
    参数:
    
    values - the map of template variables to template values.
    
    返回:
    
    the URI.
  - createURI
```
public final String createURI(String... values)
```
    Create a URI by substituting any template variables for corresponding template values.
    A URI template variable without a value will be substituted by the empty string.
    
    参数:
    
    values - the array of template values. The values will be substituted in order of occurrence of unique template variables.
    
    返回:
    
    the URI.
  - createURI
```
public final String createURI(String[] values,
                              int offset,
                              int length)
```
    Create a URI by substituting any template variables for corresponding template values.
    A URI template variable without a value will be substituted by the empty string.
    
    参数:
    
    values - the array of template values. The values will be substituted in order of occurrence of unique template variables.
    
    offset - the offset into the template value array.
    
    length - the length of the template value array.
    
    返回:
    
    the URI.
  - toString
```
public final String toString()
```
    覆盖:
    
    toString 在类中 Object
  - hashCode
```
public final int hashCode()
```
    Hash code is calculated from String of the regular expression generated from the template.
    
    覆盖:
    
    hashCode 在类中 Object
    
    返回:
    
    the hash code.
  - equals
```
public final boolean equals(Object o)
```
    Equality is calculated from the String of the regular expression generated from the templates.
    
    覆盖:
    
    equals 在类中 Object
    
    参数:
    
    o - the reference object with which to compare.
    
    返回:
    
    true if equals, otherwise false.
  - createURI
```
public static String createURI(String scheme,
                               String authority,
                               String userInfo,
                               String host,
                               String port,
                               String path,
                               String query,
                               String fragment,
                               Map<String,?> values,
                               boolean encode,
                               boolean encodeSlashInPath)
```
    Construct a URI from the component parts each of which may contain template variables.
    A template values is an Object instance MUST support the toString() method to convert the template value to a String instance.
    
    参数:
    
    scheme - the URI scheme component.
    
    authority - the URI authority component.
    
    userInfo - the URI user info component.
    
    host - the URI host component.
    
    port - the URI port component.
    
    path - the URI path component.
    
    query - the URI query component.
    
    fragment - the URI fragment component.
    
    values - the template variable to value map.
    
    encode - if true encode a template value according to the correspond component type of the associated template variable, otherwise contextually encode the template value.
    
    encodeSlashInPath - if true, the slash ('/') characters in parameter values will be encoded if the template is placed in the URI path component, otherwise the slash characters will not be encoded in path templates.
    
    返回:
    
    a URI.
  - createURIWithStringValues
```
public static String createURIWithStringValues(String scheme,
                                               String authority,
                                               String userInfo,
                                               String host,
                                               String port,
                                               String path,
                                               String query,
                                               String fragment,
                                               Map<String,?> values,
                                               boolean encode,
                                               boolean encodeSlashInPath)
```
    Construct a URI from the component parts each of which may contain template variables.
    A template value is an Object instance that MUST support the toString() method to convert the template value to a String instance.
    
    参数:
    
    scheme - the URI scheme component.
    
    authority - the URI authority info component.
    
    userInfo - the URI user info component.
    
    host - the URI host component.
    
    port - the URI port component.
    
    path - the URI path component.
    
    query - the URI query component.
    
    fragment - the URI fragment component.
    
    values - the template variable to value map.
    
    encode - if true encode a template value according to the correspond component type of the associated template variable, otherwise contextually encode the template value.
    
    encodeSlashInPath - if true, the slash ('/') characters in parameter values will be encoded if the template is placed in the URI path component, otherwise the slash characters will not be encoded in path templates.
    
    返回:
    
    a URI.
  - createURI
```
public static String createURI(String scheme,
                               String authority,
                               String userInfo,
                               String host,
                               String port,
                               String path,
                               String query,
                               String fragment,
                               Object[] values,
                               boolean encode,
                               boolean encodeSlashInPath)
```
    Construct a URI from the component parts each of which may contain template variables.
    The template values are an array of Object and each Object instance MUST support the toString() method to convert the template value to a String instance.
    
    参数:
    
    scheme - the URI scheme component.
    
    authority - the URI authority component.
    
    userInfo - the URI user info component.
    
    host - the URI host component.
    
    port - the URI port component.
    
    path - the URI path component.
    
    query - the URI query component.
    
    fragment - the URI fragment component.
    
    values - the array of template values.
    
    encode - if true encode a template value according to the correspond component type of the associated template variable, otherwise contextually encode the template value.
    
    encodeSlashInPath - if true, the slash ('/') characters in parameter values will be encoded if the template is placed in the URI path component, otherwise the slash characters will not be encoded in path templates.
    
    返回:
    
    a URI.
  - createURIWithStringValues
```
public static String createURIWithStringValues(String scheme,
                                               String authority,
                                               String userInfo,
                                               String host,
                                               String port,
                                               String path,
                                               String query,
                                               String fragment,
                                               String[] values,
                                               boolean encode,
                                               boolean encodeSlashInPath)
```
    Construct a URI from the component parts each of which may contain template variables.
    
    参数:
    
    scheme - the URI scheme component.
    
    authority - the URI authority component.
    
    userInfo - the URI user info component.
    
    host - the URI host component.
    
    port - the URI port component.
    
    path - the URI path component.
    
    query - the URI query component.
    
    fragment - the URI fragment component.
    
    values - the array of template values.
    
    encode - if true encode a template value according to the correspond component type of the associated template variable, otherwise contextually encode the template value.
    
    encodeSlashInPath - if true, the slash ('/') characters in parameter values will be encoded if the template is placed in the URI path component, otherwise the slash characters will not be encoded in path templates.
    
    返回:
    
    a URI.
  - resolveTemplateValues
```
public static String resolveTemplateValues(UriComponent.Type type,
                                           String template,
                                           boolean encode,
                                           Map<String,?> _mapValues)
```
    Resolves template variables in the given template from _mapValues. Resolves only these variables which are defined in the _mapValues leaving other variables unchanged.
    
    参数:
    
    type - Type of the template (port, path, query, ...).
    
    template - Input uri component to resolve.
    
    encode - True if template values from _mapValues should be percent encoded.
    
    _mapValues - Map with template variables as keys and template values as values. None of them should be null.
    
    返回:
    
    String with resolved template variables.
    
    抛出:
    
    IllegalArgumentException - when _mapValues value is null.

类 UriTemplate

字段概要

构造器概要

方法概要

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

字段详细资料

COMPARATOR

EMPTY

构造器详细资料

UriTemplate

UriTemplate

方法详细资料

resolve

resolve

normalize

normalize

relativize

getTemplate

getPattern

endsWithSlash

getTemplateVariables

isTemplateVariablePresent

getNumberOfExplicitRegexes

getNumberOfRegexGroups

getNumberOfExplicitCharacters

getNumberOfTemplateVariables

match

match

createURI

createURI

createURI

toString

hashCode

equals

createURI

createURIWithStringValues

createURI

createURIWithStringValues

resolveTemplateValues