org.apache.juneau.rest

Class UrlPathPattern

java.lang.Object

org.apache.juneau.rest.UrlPathPattern

All Implemented Interfaces:

Comparable<UrlPathPattern>

public final class UrlPathPattern
extends Object
implements Comparable<UrlPathPattern>

A parsed path pattern constructed from a @RestMethod.path() value.

Handles aspects of matching and precedence ordering.

Constructor Summary

Constructors

Constructor and Description
UrlPathPattern(String patternString) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(UrlPathPattern o) Comparator for this object.
boolean	equals(Object o)
String	getPatternString() Bean property getter: patternString.
String[]	getVars() Bean property getter: vars.
int	hashCode()
protected String[]	match(String path) Returns a non-null value if the specified path matches this pattern.
String	toRegEx() Returns this path pattern as the compiled regular expression.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlPathPattern

public UrlPathPattern(String patternString)

Constructor.

Parameters:

patternString - The raw pattern string from the @RestMethod.path() annotation.

Method Detail

match

protected String[] match(String path)

Returns a non-null value if the specified path matches this pattern.

Parameters:

path - The path to match against.

Returns:

An array of values matched against "{var}" variable in the pattern, or an empty array if the pattern matched but no vars were present, or null if the specified path didn't match the pattern.

compareTo

public int compareTo(UrlPathPattern o)

Comparator for this object.

The comparator is designed to order URL pattern from most-specific to least-specific. For example, the following patterns would be ordered as follows:

1. /foo/bar
2. /foo/bar/*
3. /foo/{id}/bar
4. /foo/{id}/bar/*
5. /foo/{id}
6. /foo/{id}/*
7. /foo
8. /foo/*

Specified by:

compareTo in interface Comparable<UrlPathPattern>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toRegEx

public String toRegEx()

Returns this path pattern as the compiled regular expression.

Useful for debugging.

Returns:

The path pattern.

getVars

public String[] getVars()

Bean property getter: vars.

Returns:

The value of the vars property on this bean, or null if it is not set.

getPatternString

public String getPatternString()

Bean property getter: patternString.

Returns:

The value of the patternString property on this bean, or null if it is not set.