PathMap (Jetty :: Project 9.2.21.v20170120 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap<String,O>
  - - org.eclipse.jetty.http.PathMap<O>

All Implemented Interfaces:: Serializable, Cloneable, Map<String,O>

public class PathMap<O>
extends HashMap<String,O>

URI path map to Object. This mapping implements the path specification recommended in the 2.2 Servlet API. Path specifications can be of the following forms:

 /foo/bar           - an exact path specification.
 /foo/*             - a prefix path specification (must end '/*').
 *.ext              - a suffix path specification.
 /                  - the default path specification.
 ""                 - the / path specification

Matching is performed in the following order

Exact match.
Longest prefix match.
Longest suffix match.
default. Multiple path specifications can be mapped by providing a list of specifications. By default this class uses characters ":," as path separators, unless configured differently by calling the static method @see PathMap#setPathSpecSeparators(String)
Special characters within paths such as '?� and ';' are not treated specially as it is assumed they would have been either encoded in the original URL or stripped from the path.
This class is not synchronized. If concurrent modifications are possible then it should be synchronized at a higher level.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PathMap.MappedEntry<O>

static class PathMap.PathSet
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested Classes
Modifier and Type	Class and Description
`static class`	`PathMap.MappedEntry<O>`
`static class`	`PathMap.PathSet`

Constructor Summary

Constructors
Constructor and Description

PathMap()

PathMap(boolean noDefault)

PathMap(int capacity)

PathMap(Map<String,? extends O> m)
Construct from dictionary PathMap.

Constructors
Constructor and Description
`PathMap()`
`PathMap(boolean noDefault)`
`PathMap(int capacity)`
`PathMap(Map<String,? extends O> m)` Construct from dictionary PathMap.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()`
`boolean`	`containsMatch(String path)` Return whether the path matches any entries in the PathMap, excluding the default entry
`PathMap.MappedEntry<O>`	`getMatch(String path)` Get the entry mapped by the best specification.
`List<? extends Map.Entry<String,O>>`	`getMatches(String path)` Get all entries matched by the path.
`O`	`match(String path)` Get object matched by the path.
`static boolean`	`match(String pathSpec, String path)`
`static boolean`	`match(String pathSpec, String path, boolean noDefault)`
`static String`	`pathInfo(String pathSpec, String path)` Return the portion of a path that is after a path spec.
`static String`	`pathMatch(String pathSpec, String path)` Return the portion of a path that matches a path spec.
`O`	`put(String pathSpec, O object)` Add a single path match to the PathMap.
`static String`	`relativePath(String base, String pathSpec, String path)` Relative path.
`O`	`remove(Object pathSpec)`
`static void`	`setPathSpecSeparators(String s)` Set the path spec separator.

Methods inherited from class java.util.HashMap
clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, putAll, size, values

Methods inherited from class java.util.AbstractMap
equals, hashCode, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
equals, hashCode

- Constructor Detail
  - PathMap
```
public PathMap()
```
  - PathMap
```
public PathMap(boolean noDefault)
```
  - PathMap
```
public PathMap(int capacity)
```
  - PathMap
```
public PathMap(Map<String,? extends O> m)
```
    Construct from dictionary PathMap.
- Method Detail
  - setPathSpecSeparators
```
public static void setPathSpecSeparators(String s)
```
    Set the path spec separator. Multiple path specification may be included in a single string if they are separated by the characters set in this string. By default this class uses ":," characters as path separators.
    
    Parameters:
    s - separators
  - put
```
public O put(String pathSpec,
    O object)
```
    Add a single path match to the PathMap.
    
    Specified by:
    
    put in interface Map<String,O>
    
    Overrides:
    
    put in class HashMap<String,O>
    
    Parameters:
    pathSpec - The path specification, or comma separated list of path specifications.
    object - The object the path maps to
  - match
```
public O match(String path)
```
    Get object matched by the path.
    
    Parameters:
    path - the path.
    
    Returns:
    Best matched object or null.
  - getMatch
```
public PathMap.MappedEntry<O> getMatch(String path)
```
    Get the entry mapped by the best specification.
    
    Parameters:
    path - the path.
    
    Returns:
    Map.Entry of the best matched or null.
  - getMatches
```
public List<? extends Map.Entry<String,O>> getMatches(String path)
```
    Get all entries matched by the path. Best match first.
    
    Parameters:
    path - Path to match
    
    Returns:
    List of Map.Entry instances key=pathSpec
  - containsMatch
```
public boolean containsMatch(String path)
```
    Return whether the path matches any entries in the PathMap, excluding the default entry
    
    Parameters:
    path - Path to match
    
    Returns:
    Whether the PathMap contains any entries that match this
  - remove
```
public O remove(Object pathSpec)
```
    Specified by:
    
    remove in interface Map<String,O>
    
    Overrides:
    
    remove in class HashMap<String,O>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<String,O>
    
    Overrides:
    
    clear in class HashMap<String,O>
  - match
```
public static boolean match(String pathSpec,
            String path)
                     throws IllegalArgumentException
```
    Returns:
    true if match.
    
    Throws:
    
    IllegalArgumentException
  - match
```
public static boolean match(String pathSpec,
            String path,
            boolean noDefault)
                     throws IllegalArgumentException
```
    Returns:
    true if match.
    
    Throws:
    
    IllegalArgumentException
  - pathMatch
```
public static String pathMatch(String pathSpec,
               String path)
```
    Return the portion of a path that matches a path spec.
    
    Returns:
    null if no match at all.
  - pathInfo
```
public static String pathInfo(String pathSpec,
              String path)
```
    Return the portion of a path that is after a path spec.
    
    Returns:
    The path info string
  - relativePath
```
public static String relativePath(String base,
                  String pathSpec,
                  String path)
```
    Relative path.
    
    Parameters:
    base - The base the path is relative to.
    pathSpec - The spec of the path segment to ignore.
    path - the additional path
    
    Returns:
    base plus path with pathspec removed

Class PathMap<O>

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Constructor Summary

Method Summary

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

PathMap

PathMap

PathMap

PathMap

Method Detail

setPathSpecSeparators

put

match

getMatch

getMatches

containsMatch

remove

clear

match

match

pathMatch

pathInfo

relativePath