org.springframework.web.util.pattern

Class PathElement

java.lang.Object

org.springframework.web.util.pattern.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
protected static MultiValueMap<java.lang.String,java.lang.String>	NO_PARAMETERS
protected int	pos
protected PathElement	prev
protected char	separator
protected static int	WILDCARD_WEIGHT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	getCaptureCount() Return the number of variables captured by the path element.
abstract char[]	getChars()
abstract int	getNormalizedLength() Return the length of the path element where captures are considered to be one character long.
int	getScore() Return the score for this PathElement, combined score is used to compare parsed patterns.
int	getWildcardCount() Return the number of wildcard elements (*, ?) in the path element.
protected boolean	isNoMorePattern() Return if the there are no more PathElements in the pattern.
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

NO_PARAMETERS

protected static final MultiValueMap<java.lang.String,java.lang.String> NO_PARAMETERS

pos

protected final int pos

separator

protected final char separator

next

@Nullable
protected PathElement next

prev

@Nullable
protected PathElement prev

Constructor Detail

PathElement

PathElement(int pos,
            char separator)

Create a new path element.

Parameters:

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

separator - the separator in use in the path pattern

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 it matches, otherwise false

getNormalizedLength

public abstract int getNormalizedLength()

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

Returns:

the normalized length

getChars

public abstract char[] getChars()

getCaptureCount

public int getCaptureCount()

Return the number of variables captured by the path element.

getWildcardCount

public int getWildcardCount()

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

getScore

public int getScore()

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

isNoMorePattern

protected final boolean isNoMorePattern()

Return if the there are no more PathElements in the pattern.

Returns:

true if the there are no more elements