org.springframework.web.util.pattern

Class CaptureTheRestPathElement

java.lang.Object

org.springframework.web.util.pattern.PathElement

org.springframework.web.util.pattern.CaptureTheRestPathElement

class CaptureTheRestPathElement
extends PathElement

A path element representing capturing the rest of a path. In the pattern '/foo/{*foobar}' the /{*foobar} is represented as a CaptureTheRestPathElement.

Since:

5.0

Author:

Andy Clement

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	variableName

Fields inherited from class org.springframework.web.util.pattern.PathElement

CAPTURE_VARIABLE_WEIGHT, next, NO_PARAMETERS, pos, prev, separator, WILDCARD_WEIGHT

Constructor Summary

Constructors

Constructor and Description
CaptureTheRestPathElement(int pos, char[] captureDescriptor, char separator) Create a new CaptureTheRestPathElement instance.

Method Summary

Modifier and Type	Method and Description
int	getCaptureCount() Return the number of variables captured by the path element.
char[]	getChars()
int	getNormalizedLength() Return the length of the path element where captures are considered to be one character long.
int	getWildcardCount() Return the number of wildcard elements (*, ?) in the path element.
boolean	matches(int pathIndex, PathPattern.MatchingContext matchingContext) Attempt to match this path element.
private java.lang.String	pathToString(int fromSegment, java.util.List<PathContainer.Element> pathElements)
java.lang.String	toString()

Methods inherited from class org.springframework.web.util.pattern.PathElement

getScore, isNoMorePattern

Methods inherited from class java.lang.Object

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

Field Detail

variableName

private final java.lang.String variableName

Constructor Detail

CaptureTheRestPathElement

CaptureTheRestPathElement(int pos,
                          char[] captureDescriptor,
                          char separator)

Create a new CaptureTheRestPathElement instance.

Parameters:

pos - position of the path element within the path pattern text

captureDescriptor - a character array containing contents like '{' '*' 'a' 'b' '}'

separator - the separator used in the path pattern

Method Detail

matches

public boolean matches(int pathIndex,
                       PathPattern.MatchingContext matchingContext)

Description copied from class: PathElement

Attempt to match this path element.

Specified by:

matches in class PathElement

Parameters:

pathIndex - the current position within the candidate path

matchingContext - encapsulates context for the match including the candidate

Returns:

true if it matches, otherwise false

pathToString

private java.lang.String pathToString(int fromSegment,
                                      java.util.List<PathContainer.Element> pathElements)

getNormalizedLength

public int getNormalizedLength()

Description copied from class: PathElement

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

Specified by:

getNormalizedLength in class PathElement

Returns:

the normalized length

getWildcardCount

public int getWildcardCount()

Description copied from class: PathElement

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

Overrides:

getWildcardCount in class PathElement

getCaptureCount

public int getCaptureCount()

Description copied from class: PathElement

Return the number of variables captured by the path element.

Overrides:

getCaptureCount in class PathElement

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getChars

public char[] getChars()

Specified by:

getChars in class PathElement