org.eclipse.jetty.websocket.server.pathmap

Class PathSpec

java.lang.Object

org.eclipse.jetty.websocket.server.pathmap.PathSpec

All Implemented Interfaces:

Comparable<PathSpec>

Direct Known Subclasses:

RegexPathSpec, ServletPathSpec

public abstract class PathSpec
extends Object
implements Comparable<PathSpec>

The base PathSpec, what all other path specs are based on

Field Summary

Fields

Modifier and Type	Field and Description
protected PathSpecGroup	group
protected int	pathDepth
protected String	pathSpec
protected int	specLength

Constructor Summary

Constructors

Constructor and Description
PathSpec()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(PathSpec other)
boolean	equals(Object obj)
PathSpecGroup	getGroup()
int	getPathDepth() Get the number of path elements that this path spec declares.
abstract String	getPathInfo(String path) Return the portion of the path that is after the path spec.
abstract String	getPathMatch(String path) Return the portion of the path that matches a path spec.
String	getPathSpec() The as-provided path spec.
abstract String	getRelativePath(String base, String path) Get the relative path.
int	hashCode()
abstract boolean	matches(String path) Test to see if the provided path matches this path spec
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

pathSpec

protected String pathSpec

group

protected PathSpecGroup group

pathDepth

protected int pathDepth

specLength

protected int specLength

Constructor Detail

PathSpec

public PathSpec()

Method Detail

compareTo

public int compareTo(PathSpec other)

Specified by:

compareTo in interface Comparable<PathSpec>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getGroup

public PathSpecGroup getGroup()

getPathDepth

public 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

public abstract 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

public abstract 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

getPathSpec

public String getPathSpec()

The as-provided path spec.

Returns:

the as-provided path spec

getRelativePath

public abstract String getRelativePath(String base,
                     String path)

Get the relative path.

Parameters:

base - the base the path is relative to

path - the additional path

Returns:

the base plus path with pathSpec portion removed

hashCode

public int hashCode()

Overrides:

hashCode in class Object

matches

public abstract 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

toString

public String toString()

Overrides:

toString in class Object