Package org.eclipse.jetty.http.pathmap
Interface PathSpec
-
- All Superinterfaces:
java.lang.Comparable<PathSpec>
- All Known Implementing Classes:
AbstractPathSpec
,RegexPathSpec
,ServletPathSpec
,UriTemplatePathSpec
@Deprecated(since="2021-05-27") public interface PathSpec extends java.lang.Comparable<PathSpec>
Deprecated.The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.A path specification is a URI path template that can be matched against.Implementors must override
Object.equals(Object)
andObject.hashCode()
.
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description static PathSpec
from(java.lang.String pathSpecString)
Deprecated.java.lang.String
getDeclaration()
Deprecated.The as-provided path spec.PathSpecGroup
getGroup()
Deprecated.The spec group.int
getPathDepth()
Deprecated.Get the number of path elements that this path spec declares.java.lang.String
getPathInfo(java.lang.String path)
Deprecated.usematched(String)
insteadjava.lang.String
getPathMatch(java.lang.String path)
Deprecated.usematched(String)
insteadjava.lang.String
getPrefix()
Deprecated.A simple prefix match for the pathspec or nullint
getSpecLength()
Deprecated.The length of the spec.java.lang.String
getSuffix()
Deprecated.A simple suffix match for the pathspec or nullMatchedPath
matched(java.lang.String path)
Deprecated.Get the complete matched details of the provided path.boolean
matches(java.lang.String path)
Deprecated.usematched(String)
instead
-
-
-
Method Detail
-
from
static PathSpec from(java.lang.String pathSpecString)
Deprecated.
-
getSpecLength
int getSpecLength()
Deprecated.The length of the spec.- Returns:
- the length of the spec.
-
getGroup
PathSpecGroup getGroup()
Deprecated.The spec group.- Returns:
- the spec group.
-
getPathDepth
int getPathDepth()
Deprecated.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.usematched(String)
insteadReturn 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.usematched(String)
insteadReturn 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()
Deprecated.The as-provided path spec.- Returns:
- the as-provided path spec
-
getPrefix
java.lang.String getPrefix()
Deprecated.A simple prefix match for the pathspec or null- Returns:
- A simple prefix match for the pathspec or null
-
getSuffix
java.lang.String getSuffix()
Deprecated.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.usematched(String)
insteadTest 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)
Deprecated.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.
-
-