UriTemplateParser (Commons URI

java.lang.Object
- de.weltraumschaf.commons.uri.UriTemplateParser

```
class UriTemplateParser
extends Object
```
A URI template parser that parses JAX-RS specific URI templates.

Author:

Paul Sandoz

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static int[]`	`EMPTY_INT_ARRAY`
`private List<Integer>`	`groupCounts`
`private static String[]`	`HEX_TO_UPPERCASE_REGEX`
`private int`	`literalCharacters`
`private StringBuffer`	`literalCharactersBuffer`
`private List<String>`	`names`
`private Map<String,Pattern>`	`nameToPattern`
`private StringBuffer`	`normalizedTemplate`
`private int`	`numOfExplicitRegexes`
`private Pattern`	`pattern`
`private StringBuffer`	`regex`
`private static Set<Character>`	`RESERVED_REGEX_CHARACTERS`
`private String`	`template`
`private static Pattern`	`TEMPLATE_VALUE_PATTERN`

Constructor Summary

Constructors
Constructor and Description

UriTemplateParser(String template)
Parse a template.

Constructors
Constructor and Description
`UriTemplateParser(String template)` Parse a template.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private char`	`consumeWhiteSpace(CharacterIterator ci)`
`protected String`	`encodeLiteralCharacters(String characters)` Encode literal characters of a template.
`(package private) List<Integer>`	`getGroupCounts()` Get the capturing group counts for each template variable.
`(package private) int[]`	`getGroupIndexes()` Get the group indexes to capturing groups.
`(package private) List<String>`	`getNames()` Get the list of template names.
`(package private) Map<String,Pattern>`	`getNameToPattern()` Get the map of template names to patterns.
`(package private) String`	`getNormalizedTemplate()` Get the normalized template.
`(package private) int`	`getNumberOfExplicitRegexes()` Get the number of explicit regular expressions.
`(package private) int`	`getNumberOfLiteralCharacters()` Get the number of literal characters.
`(package private) Pattern`	`getPattern()` Get the pattern.
`(package private) String`	`getTemplate()` Get the template.
`private static String[]`	`initHexToUpperCaseRegex()`
`private static Set<Character>`	`initReserved()`
`private void`	`parse(CharacterIterator ci)`
`private void`	`parseName(CharacterIterator ci)`
`private String`	`parseRegex(CharacterIterator ci)`
`private void`	`processLiteralCharacters()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EMPTY_INT_ARRAY
```
static final int[] EMPTY_INT_ARRAY
```
  - RESERVED_REGEX_CHARACTERS
```
private static final Set<Character> RESERVED_REGEX_CHARACTERS
```
  - TEMPLATE_VALUE_PATTERN
```
private static final Pattern TEMPLATE_VALUE_PATTERN
```
  - template
```
private final String template
```
  - regex
```
private final StringBuffer regex
```
  - normalizedTemplate
```
private final StringBuffer normalizedTemplate
```
  - literalCharactersBuffer
```
private final StringBuffer literalCharactersBuffer
```
  - pattern
```
private final Pattern pattern
```
  - names
```
private final List<String> names
```
  - groupCounts
```
private final List<Integer> groupCounts
```
  - nameToPattern
```
private final Map<String,Pattern> nameToPattern
```
  - numOfExplicitRegexes
```
private int numOfExplicitRegexes
```
  - literalCharacters
```
private int literalCharacters
```
  - HEX_TO_UPPERCASE_REGEX
```
private static final String[] HEX_TO_UPPERCASE_REGEX
```
- Constructor Detail
  - UriTemplateParser
```
UriTemplateParser(String template)
           throws IllegalArgumentException
```
    Parse a template.
    
    Parameters:
    
    template - the template.
    
    Throws:
    
    IllegalArgumentException - if the template is null, an empty string or does not conform to a JAX-RS URI template.
- Method Detail
  - initReserved
```
private static Set<Character> initReserved()
```
  - getTemplate
```
final String getTemplate()
```
    Get the template.
    
    Returns:
    
    the template.
  - getPattern
```
final Pattern getPattern()
```
    Get the pattern.
    
    Returns:
    
    the pattern.
  - getNormalizedTemplate
```
final String getNormalizedTemplate()
```
    Get the normalized template.
    A normalized template is a template without any explicit regular expressions.
    
    Returns:
    
    the normalized template.
  - getNameToPattern
```
final Map<String,Pattern> getNameToPattern()
```
    Get the map of template names to patterns.
    
    Returns:
    
    the map of template names to patterns.
  - getNames
```
final List<String> getNames()
```
    Get the list of template names.
    
    Returns:
    
    the list of template names.
  - getGroupCounts
```
final List<Integer> getGroupCounts()
```
    Get the capturing group counts for each template variable.
    
    Returns:
    
    the capturing group counts.
  - getGroupIndexes
```
final int[] getGroupIndexes()
```
    Get the group indexes to capturing groups.
    Any nested capturing groups will be ignored and the the group index will refer to the top-level capturing groups associated with the templates variables.
    
    Returns:
    
    the group indexes to capturing groups.
  - getNumberOfExplicitRegexes
```
final int getNumberOfExplicitRegexes()
```
    Get the number of explicit regular expressions.
    
    Returns:
    
    the number of explicit regular expressions.
  - getNumberOfLiteralCharacters
```
final int getNumberOfLiteralCharacters()
```
    Get the number of literal characters.
    
    Returns:
    
    the number of literal characters.
  - encodeLiteralCharacters
```
protected String encodeLiteralCharacters(String characters)
```
    Encode literal characters of a template.
    
    Parameters:
    
    characters - the literal characters
    
    Returns:
    
    the encoded literal characters.
  - parse
```
private void parse(CharacterIterator ci)
```
  - processLiteralCharacters
```
private void processLiteralCharacters()
```
  - initHexToUpperCaseRegex
```
private static String[] initHexToUpperCaseRegex()
```
  - parseName
```
private void parseName(CharacterIterator ci)
```
  - parseRegex
```
private String parseRegex(CharacterIterator ci)
```
  - consumeWhiteSpace
```
private char consumeWhiteSpace(CharacterIterator ci)
```

Class UriTemplateParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_INT_ARRAY

RESERVED_REGEX_CHARACTERS

TEMPLATE_VALUE_PATTERN

template

regex

normalizedTemplate

literalCharactersBuffer

pattern

names

groupCounts

nameToPattern

numOfExplicitRegexes

literalCharacters

HEX_TO_UPPERCASE_REGEX

Constructor Detail

UriTemplateParser

Method Detail

initReserved

getTemplate

getPattern

getNormalizedTemplate

getNameToPattern

getNames

getGroupCounts

getGroupIndexes

getNumberOfExplicitRegexes

getNumberOfLiteralCharacters

encodeLiteralCharacters

parse

processLiteralCharacters

initHexToUpperCaseRegex

parseName

parseRegex

consumeWhiteSpace