org.eclipse.jetty.http.pathmap

Interface PathSpec

All Superinterfaces:

Comparable<PathSpec>

All Known Implementing Classes:

AbstractPathSpec, RegexPathSpec, ServletPathSpec, UriTemplatePathSpec

public interface PathSpec
extends Comparable<PathSpec>

A path specification is a URI path template that can be matched against.

Implementors must override Object.equals(Object) and Object.hashCode().

Method Summary

Modifier and Type	Method and Description
String	getDeclaration() The as-provided path spec.
PathSpecGroup	getGroup() The spec group.
int	getPathDepth() Get the number of path elements that this path spec declares.
String	getPathInfo(String path) Return the portion of the path that is after the path spec.
String	getPathMatch(String path) Return the portion of the path that matches a path spec.
String	getPrefix() A simple prefix match for the pathspec or null
int	getSpecLength() The length of the spec.
String	getSuffix() A simple suffix match for the pathspec or null
boolean	matches(String path) Test to see if the provided path matches this path spec

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getSpecLength

int getSpecLength()

The length of the spec.

Returns:

the length of the spec.

getGroup

PathSpecGroup getGroup()

The spec group.

Returns:

the spec group.

getPathDepth

int getPathDepth()

Get the number of path elements that this path spec declares.

This is used to determine longest match logic.

Returns:

the depth of the path segments that this spec declares

getPathInfo

String getPathInfo(String path)

Return the portion of the path that is after the path spec.

Parameters:

path - the path to match against

Returns:

the path info portion of the string

getPathMatch

String getPathMatch(String path)

Return the portion of the path that matches a path spec.

Parameters:

path - the path to match against

Returns:

the match, or null if no match at all

getDeclaration

String getDeclaration()

The as-provided path spec.

Returns:

the as-provided path spec

getPrefix

String getPrefix()

A simple prefix match for the pathspec or null

Returns:

A simple prefix match for the pathspec or null

getSuffix

String getSuffix()

A simple suffix match for the pathspec or null

Returns:

A simple suffix match for the pathspec or null

matches

boolean matches(String path)

Test to see if the provided path matches this path spec

Parameters:

path - the path to test

Returns:

true if the path matches this path spec, false otherwise