Package org.eclipse.jetty.http.pathmap

Interface PathSpec

All Superinterfaces:

java.lang.Comparable<PathSpec>

All Known Implementing Classes:

AbstractPathSpec, RegexPathSpec, ServletPathSpec, UriTemplatePathSpec

public interface PathSpec
extends java.lang.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	Description
static PathSpec	from(java.lang.String pathSpecString)
java.lang.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.
java.lang.String	getPathInfo(java.lang.String path)	Deprecated. use matched(String) instead
java.lang.String	getPathMatch(java.lang.String path)	Deprecated. use matched(String) instead
java.lang.String	getPrefix()	A simple prefix match for the pathspec or null
int	getSpecLength()	The length of the spec.
java.lang.String	getSuffix()	A simple suffix match for the pathspec or null
MatchedPath	matched(java.lang.String path)	Get the complete matched details of the provided path.
boolean	matches(java.lang.String path)	Deprecated. use matched(String) instead

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

from

static PathSpec from(java.lang.String pathSpecString)

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

@Deprecated
java.lang.String getPathInfo(java.lang.String path)

Deprecated.

use matched(String) instead

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

@Deprecated
java.lang.String getPathMatch(java.lang.String path)

Deprecated.

use matched(String) instead

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

java.lang.String getDeclaration()

The as-provided path spec.

Returns:

the as-provided path spec

getPrefix

java.lang.String getPrefix()

A simple prefix match for the pathspec or null

Returns:

A simple prefix match for the pathspec or null

getSuffix

java.lang.String getSuffix()

A simple suffix match for the pathspec or null

Returns:

A simple suffix match for the pathspec or null

matches

@Deprecated
boolean matches(java.lang.String path)

Deprecated.

use matched(String) instead

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

matched

MatchedPath matched(java.lang.String path)

Get the complete matched details of the provided path.

Parameters:

path - the path to test

Returns:

the matched details, if a match was possible, or null if not able to be matched.