org.apache.juneau.rest.util

Class UrlPathPattern

java.lang.Object

org.apache.juneau.rest.util.UrlPathPattern

All Implemented Interfaces:

Comparable<UrlPathPattern>

@BeanIgnore
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.
String[]	getVars() Returns the variable names found in the pattern.
boolean	hasVars() Returns true if this path pattern contains variables.
UrlPathPatternMatch	match(String path) Returns a non-null value if the specified path matches this pattern.
UrlPathPatternMatch	match(UrlPathInfo pathInfo) Returns a non-null value if the specified path matches this pattern.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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

public UrlPathPatternMatch match(String path)

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

Parameters:

path - The path to match against.

Returns:

A pattern match object, or null if the path didn't match this pattern.

match

public UrlPathPatternMatch match(UrlPathInfo pathInfo)

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

Parameters:

pathInfo - The path to match against.

Returns:

A pattern match object, or null if the path didn't match this pattern.

getVars

public String[] getVars()

Returns the variable names found in the pattern.

Returns:

The variable names or an empty array if no variables found.
Modifying the returned array does not modify this object.

hasVars

public boolean hasVars()

Returns true if this path pattern contains variables.

Returns:

true if this path pattern contains variables.

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>

toString

public String toString()

Overrides:

toString in class Object