A path pattern that is a regular expression generated from a URI path template.

The path pattern is normalized by removing a terminating "/" if present.

The path pattern is post-fixed with a right hand pattern that consists of either a matching group that matches zero or more path segments, see RightHandPath#capturingZeroOrMoreSegments, or zero path segments, see RightHandPath#capturingZeroSegments.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	PathPattern.RightHandPath The set of right hand path patterns that may be appended to a path pattern.

Field Summary

Modifier and Type	Field and Description
public static final Comparator<PathPattern>	COMPARATOR Path pattern comparator that defers to `comparing the templates` associated with the patterns.
public static final PathPattern	EMPTY_PATTERN Empty path pattern matching only empty string.
public static final PathPattern	END_OF_PATH_PATTERN Path pattern matching the end of a URI path.
public static final PathPattern	OPEN_ROOT_PATH_PATTERN Path pattern matching the any URI path.
private final UriTemplate	template

Inherited from org.glassfish.tyrus.core.uri.internal.PatternWithGroups:: EMPTY

Constructor Summary

Access	Constructor and Description
private	PathPattern()
public	PathPattern(String the path template. template) Create a path pattern and post fix with `RightHandPath#capturingZeroOrMoreSegments`.
public	PathPattern(PathTemplate the path template template) Create a path pattern and post fix with `RightHandPath#capturingZeroOrMoreSegments`.
public	PathPattern(String the path template. template, PathPattern.RightHandPath the right hand path pattern postfix. rhpp) Create a path pattern and post fix with a right hand path pattern.
public	PathPattern(PathTemplate the path template. template, PathPattern.RightHandPath the right hand path pattern postfix. rhpp) Create a path pattern and post fix with a right hand path pattern.

Method Summary

Modifier and Type	Method and Description
private static int[]	addIndexForRightHandPathCapturingGroup(int numberOfGroups, int[] indexes)
public static PathPattern	Returns: closed path pattern for the same path template. asClosed(PathPattern an (open) path pattern to convert to a closed pattern. pattern) Return a new path pattern with a same path template but a `closed` right hand path.
public UriTemplate	getTemplate()
private static String	postfixWithCapturingGroup(String regex)
private static String	postfixWithCapturingGroup(String regex, PathPattern.RightHandPath rhpp)

Inherited from org.glassfish.tyrus.core.uri.internal.PatternWithGroups:: equals getGroupIndexes getRegex hashCode match match match toString

Field Detail

COMPARATOR	back to summary
public static final Comparator<PathPattern> COMPARATOR Path pattern comparator that defers to `comparing the templates` associated with the patterns.

EMPTY_PATTERN	back to summary
public static final PathPattern EMPTY_PATTERN Empty path pattern matching only empty string.

END_OF_PATH_PATTERN	back to summary
public static final PathPattern END_OF_PATH_PATTERN Path pattern matching the end of a URI path. Can be either empty `""` or contain a trailing slash `"/"`.

OPEN_ROOT_PATH_PATTERN	back to summary
public static final PathPattern OPEN_ROOT_PATH_PATTERN Path pattern matching the any URI path.

template	back to summary
private final UriTemplate template

Constructor Detail

PathPattern	back to summary
private PathPattern()

PathPattern back to summary

PathPattern	back to summary
public PathPattern(String template) Create a path pattern and post fix with `RightHandPath#capturingZeroOrMoreSegments`. Parameters template:String the path template. See Also `PathPattern(String, PathPattern.RightHandPath)`

public PathPattern(String template)

Create a path pattern and post fix with RightHandPath#capturingZeroOrMoreSegments.

Parameters

template:String: the path template.

PathPattern back to summary

PathPattern	back to summary
public PathPattern(PathTemplate template) Create a path pattern and post fix with `RightHandPath#capturingZeroOrMoreSegments`. Parameters template:PathTemplate the path template See Also `PathPattern(PathTemplate, PathPattern.RightHandPath)`

public PathPattern(PathTemplate template)

Create a path pattern and post fix with RightHandPath#capturingZeroOrMoreSegments.

Parameters

template:PathTemplate: the path template

PathPattern	back to summary
public PathPattern(String template, PathPattern.RightHandPath rhpp) Create a path pattern and post fix with a right hand path pattern. Parameters template:String the path template. rhpp:PathPattern.RightHandPath the right hand path pattern postfix.

PathPattern

back to summary

public PathPattern(String template, PathPattern.RightHandPath rhpp)

Create a path pattern and post fix with a right hand path pattern.

Parameters

template:String: the path template.
rhpp:PathPattern.RightHandPath: the right hand path pattern postfix.

PathPattern	back to summary
public PathPattern(PathTemplate template, PathPattern.RightHandPath rhpp) Create a path pattern and post fix with a right hand path pattern. Parameters template:PathTemplate the path template. rhpp:PathPattern.RightHandPath the right hand path pattern postfix.

PathPattern

back to summary

public PathPattern(PathTemplate template, PathPattern.RightHandPath rhpp)

Create a path pattern and post fix with a right hand path pattern.

Parameters

template:PathTemplate: the path template.
rhpp:PathPattern.RightHandPath: the right hand path pattern postfix.

Method Detail

addIndexForRightHandPathCapturingGroup	back to summary
private static int[] addIndexForRightHandPathCapturingGroup(int numberOfGroups, int[] indexes)

asClosed back to summary

asClosed	back to summary
public static PathPattern asClosed(PathPattern pattern) Return a new path pattern with a same path template but a `closed` right hand path. Parameters pattern:PathPattern an (open) path pattern to convert to a closed pattern. Returns:PathPattern closed path pattern for the same path template.

public static PathPattern asClosed(PathPattern pattern)

Return a new path pattern with a same path template but a closed right hand path.

Parameters

pattern:PathPattern: an (open) path pattern to convert to a closed pattern.

Returns:PathPattern

closed path pattern for the same path template.

getTemplate	back to summary
public UriTemplate getTemplate()

postfixWithCapturingGroup	back to summary
private static String postfixWithCapturingGroup(String regex)

postfixWithCapturingGroup	back to summary
private static String postfixWithCapturingGroup(String regex, PathPattern.RightHandPath rhpp)

org.glassfish.tyrus.core.uri.internal back to summary

public final Enum PathPattern.RightHandPath

Class Inheritance

extends Enum<PathPattern.RightHandPath>

java.lang.Object
java.lang.Enum
org.glassfish.tyrus.core.uri.internal.PathPattern.RightHandPath

The set of right hand path patterns that may be appended to a path pattern.

Field Summary

Modifier and Type	Field and Description
public static final PathPattern.RightHandPath	capturingZeroOrMoreSegments A capturing group that matches zero or more path segments and keeps the matching path template open.
public static final PathPattern.RightHandPath	capturingZeroSegments A capturing group that matches zero segments and effectively closes the matching path template.
private final String	regex

Constructor Summary

Access	Constructor and Description
private	RightHandPath(String regex)

Method Summary

Modifier and Type	Method and Description
private String	getRegex()
public static PathPattern.RightHandPath	valueOf(String name)
public static PathPattern.RightHandPath[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

capturingZeroOrMoreSegments	back to summary
public static final PathPattern.RightHandPath capturingZeroOrMoreSegments A capturing group that matches zero or more path segments and keeps the matching path template open.

capturingZeroSegments	back to summary
public static final PathPattern.RightHandPath capturingZeroSegments A capturing group that matches zero segments and effectively closes the matching path template.

regex	back to summary
private final String regex

Constructor Detail

RightHandPath	back to summary
private RightHandPath(String regex)

Method Detail

getRegex	back to summary
private String getRegex()

valueOf	back to summary
public static PathPattern.RightHandPath valueOf(String name)

values	back to summary
public static PathPattern.RightHandPath[] values()

public final Class PathPattern

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum PathPattern.RightHandPath

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail