org.springframework.web.util.patterns

Class PathElement

java.lang.Object

org.springframework.web.util.patterns.PathElement

Direct Known Subclasses:

CaptureTheRestPathElement, CaptureVariablePathElement, LiteralPathElement, RegexPathElement, SeparatorPathElement, SingleCharWildcardedPathElement, WildcardPathElement, WildcardTheRestPathElement

abstract class PathElement
extends java.lang.Object

Common supertype for the Ast nodes created to represent a path pattern.

Since:

5.0

Author:

Andy Clement

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	CAPTURE_VARIABLE_WEIGHT
protected PathElement	next The next path element in the chain
protected int	pos Position in the pattern where this path element starts
protected PathElement	prev The previous path element in the chain
protected static int	WILDCARD_WEIGHT

Constructor Summary

Constructors

Constructor and Description
PathElement(int pos) Create a new path element.

Method Summary

Modifier and Type	Method and Description
int	getCaptureCount()
abstract int	getNormalizedLength()
int	getScore()
int	getWildcardCount()
abstract boolean	matches(int candidatePos, PathPattern.MatchingContext matchingContext) Attempt to match this path element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WILDCARD_WEIGHT

protected static final int WILDCARD_WEIGHT

See Also:

Constant Field Values

CAPTURE_VARIABLE_WEIGHT

protected static final int CAPTURE_VARIABLE_WEIGHT

See Also:

Constant Field Values

pos

protected int pos

Position in the pattern where this path element starts

next

protected PathElement next

The next path element in the chain

prev

protected PathElement prev

The previous path element in the chain

Constructor Detail

PathElement

PathElement(int pos)

Create a new path element.

Parameters:

pos - the position where this path element starts in the pattern data

Method Detail

matches

public abstract boolean matches(int candidatePos,
                                PathPattern.MatchingContext matchingContext)

Attempt to match this path element.

Parameters:

candidatePos - the current position within the candidate path

matchingContext - encapsulates context for the match including the candidate

Returns:

true if matches, otherwise false

getNormalizedLength

public abstract int getNormalizedLength()

Returns:

the length of the path element where captures are considered to be one character long

getCaptureCount

public int getCaptureCount()

Returns:

the number of variables captured by the path element

getWildcardCount

public int getWildcardCount()

Returns:

the number of wildcard elements (*, ?) in the path element

getScore

public int getScore()

Returns:

the score for this PathElement, combined score is used to compare parsed patterns.