Class UriMatchTemplate

java.lang.Object

io.micronaut.http.uri.UriTemplate

io.micronaut.http.uri.UriMatchTemplate

All Implemented Interfaces:

UriMatcher, Comparable<UriTemplate>

Direct Known Subclasses:

UriTypeMatchTemplate

@NullUnmarked
public class UriMatchTemplate
extends UriTemplate
implements UriMatcher

Extends UriTemplate and adds the ability to match a URI to a given template using the UriMatcher.match(java.net.URI) method.

Since:

1.0

Author:

Graeme Rocher

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	UriMatchTemplate.DefaultUriMatchInfo	The default UriMatchInfo implementation.
protected static class	UriMatchTemplate.UriMatchTemplateParser	Extended version of UriTemplate.UriTemplateParser that builds a regular expression to match a path.

Nested classes/interfaces inherited from class UriTemplate

UriTemplate.PathSegment, UriTemplate.UriTemplateParser

Field Summary

Fields

Modifier and Type	Field	Description
protected StringBuilder	pattern
protected static final String	VARIABLE_MATCH_PATTERN
protected List<UriMatchVariable>	variables

Fields inherited from class UriTemplate

templateString

Constructor Summary

Constructors

Modifier	Constructor	Description
	UriMatchTemplate(CharSequence templateString)	Construct a new URI template for the given template.
protected	UriMatchTemplate(CharSequence templateString, Object... parserArguments)	Construct a new URI template for the given template.
protected	UriMatchTemplate(CharSequence templateString, List<UriTemplate.PathSegment> segments, Pattern matchPattern, List<UriMatchVariable> variables)

Method Summary

Modifier and Type	Method	Description
protected UriTemplate.UriTemplateParser	createParser(String templateString, Object... parserArguments)	Creates a parser.
List<String>	getVariableNames()
List<UriMatchVariable>	getVariables()
Optional<UriMatchInfo>	match(String uri)	Match the given URI string.
UriMatchTemplate	nest(CharSequence uriTemplate)	Nests another URI template with this template.
protected UriMatchTemplate	newUriMatchTemplate(CharSequence uriTemplate, List<UriTemplate.PathSegment> newSegments, Pattern newPattern, List<UriMatchVariable> variables)
protected UriTemplate	newUriTemplate(CharSequence uriTemplate, List<UriTemplate.PathSegment> newSegments)
static UriMatchTemplate	of(String uri)	Create a new UriTemplate for the given URI.
String	toPathString()	Returns the path string excluding any query variables.
@Nullable UriMatchInfo	tryMatch(String uri)	Match the given URI string.

Methods inherited from class UriTemplate

buildNestedSegments, compareTo, equals, expand, expand, getPathVariableSegmentCount, getRawSegmentCount, getRawSegmentLength, getTemplateString, getVariableSegmentCount, hashCode, nest, normalizeNested, toString, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface UriMatcher

match

Field Details

VARIABLE_MATCH_PATTERN

protected static final String VARIABLE_MATCH_PATTERN

See Also:

• Constant Field Values

pattern

protected StringBuilder pattern

variables

protected List<UriMatchVariable> variables

Constructor Details

UriMatchTemplate

public UriMatchTemplate(CharSequence templateString)

Construct a new URI template for the given template.

Parameters:

templateString - The template string

UriMatchTemplate

protected UriMatchTemplate(CharSequence templateString,
 Object... parserArguments)

Construct a new URI template for the given template.

Parameters:

templateString - The template string

parserArguments - The parsed arguments

UriMatchTemplate

protected UriMatchTemplate(CharSequence templateString,
 List<UriTemplate.PathSegment> segments,
 Pattern matchPattern,
 List<UriMatchVariable> variables)

Parameters:

templateString - The template

segments - The list of segments

matchPattern - The match pattern

variables - The variables

Method Details

newUriMatchTemplate

protected UriMatchTemplate newUriMatchTemplate(CharSequence uriTemplate,
 List<UriTemplate.PathSegment> newSegments,
 Pattern newPattern,
 List<UriMatchVariable> variables)

Parameters:

uriTemplate - The template

newSegments - The list of new segments

newPattern - The list of new patters

variables - The variables

Returns:

An instance of UriMatchTemplate

getVariableNames

public List<String> getVariableNames()

Returns:

The variables this template expects

getVariables

public List<UriMatchVariable> getVariables()

Returns:

The variables this template expects

toPathString

public String toPathString()

Returns the path string excluding any query variables.

Returns:

The path string

match

public Optional<UriMatchInfo> match(String uri)

Match the given URI string.

Specified by:

match in interface UriMatcher

Parameters:

uri - The uRI

Returns:

an optional match

tryMatch

public @Nullable UriMatchInfo tryMatch(String uri)

Match the given URI string.

Parameters:

uri - The uRI

Returns:

a match or null

nest

public UriMatchTemplate nest(CharSequence uriTemplate)

Description copied from class: UriTemplate

Nests another URI template with this template.

Overrides:

nest in class UriTemplate

Parameters:

uriTemplate - The URI template. If it does not begin with forward slash it will automatically be appended with forward slash

Returns:

The new URI template

of

public static UriMatchTemplate of(String uri)

Create a new UriTemplate for the given URI.

Parameters:

uri - The URI

Returns:

The template

newUriTemplate

protected UriTemplate newUriTemplate(CharSequence uriTemplate,
 List<UriTemplate.PathSegment> newSegments)

Overrides:

newUriTemplate in class UriTemplate

Parameters:

uriTemplate - The URI template

newSegments - The new segments

Returns:

The new UriTemplate

createParser

protected UriTemplate.UriTemplateParser createParser(String templateString,
 Object... parserArguments)

Description copied from class: UriTemplate

Creates a parser.

Overrides:

createParser in class UriTemplate

Parameters:

templateString - The template

parserArguments - The parsed arguments

Returns:

The created parser