Top Description Inners Fields Constructors Methods
io.undertow.util

public Class PathTemplateMatcher<T>

extends Object
Class Inheritance
Imports
io.undertow.UndertowMessages, java.util.Comparator, .HashSet, .Iterator, .LinkedHashMap, .Map, .Map.Entry, .Set, .TreeSet
Utility class that provides fast path matching of path templates. Templates are stored in a map based on the stem of the template, and matches longest stem first.

Todo

we can probably do this faster using a trie type structure, but I think the current impl should perform ok most of the time

Author
Stuart Douglas

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
PathTemplateMatcher.PathMatchResult<T>

private class
PathTemplateMatcher.PathTemplateHolder

Field Summary

Modifier and TypeField and Description
private volatile int[]
lengths

lengths of all registered paths

private Map<String, Set<PathTemplateMatcher<T>.PathTemplateHolder>>
pathTemplateMap

Map of path template stem to the path templates that share the same base.

Constructor Summary

AccessConstructor and Description
public
PathTemplateMatcher()

Method Summary

Modifier and TypeMethod and Description
public synchronized PathTemplateMatcher<T>
add(final PathTemplate template, final T value)

public synchronized PathTemplateMatcher<T>
add(final String pathTemplate, final T value)

public synchronized PathTemplateMatcher<T>
addAll(PathTemplateMatcher<T> pathTemplateMatcher)

private void
buildLengths()

public synchronized T
get(String template)

pack-priv Map<String, Set<PathTemplateMatcher<T>.PathTemplateHolder>>
getPathTemplateMap()

public Set<PathTemplate>
getPathTemplates()

private PathTemplateMatcher.PathMatchResult<T>
handleStemMatch(Set<PathTemplateMatcher<T>.PathTemplateHolder> entry, final String path, final Map<String, String> params)

public PathTemplateMatcher.PathMatchResult<T>
match(final String path)

public synchronized PathTemplateMatcher<T>
remove(final String pathTemplate)

private synchronized PathTemplateMatcher<T>
remove(PathTemplate template)

private String
trimBase(PathTemplate template)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

lengthsback to summary
private volatile int[] lengths

lengths of all registered paths

pathTemplateMapback to summary
private Map<String, Set<PathTemplateMatcher<T>.PathTemplateHolder>> pathTemplateMap

Map of path template stem to the path templates that share the same base.

Constructor Detail

PathTemplateMatcherback to summary
public PathTemplateMatcher()

Method Detail

addback to summary
public synchronized PathTemplateMatcher<T> add(final PathTemplate template, final T value)
addback to summary
public synchronized PathTemplateMatcher<T> add(final String pathTemplate, final T value)
addAllback to summary
public synchronized PathTemplateMatcher<T> addAll(PathTemplateMatcher<T> pathTemplateMatcher)
buildLengthsback to summary
private void buildLengths()
getback to summary
public synchronized T get(String template)
getPathTemplateMapback to summary
pack-priv Map<String, Set<PathTemplateMatcher<T>.PathTemplateHolder>> getPathTemplateMap()
getPathTemplatesback to summary
public Set<PathTemplate> getPathTemplates()
handleStemMatchback to summary
private PathTemplateMatcher.PathMatchResult<T> handleStemMatch(Set<PathTemplateMatcher<T>.PathTemplateHolder> entry, final String path, final Map<String, String> params)
matchback to summary
public PathTemplateMatcher.PathMatchResult<T> match(final String path)
removeback to summary
public synchronized PathTemplateMatcher<T> remove(final String pathTemplate)
removeback to summary
private synchronized PathTemplateMatcher<T> remove(PathTemplate template)
trimBaseback to summary
private String trimBase(PathTemplate template)
io.undertow.util back to summary

public Class PathTemplateMatcher.PathMatchResult<T>

extends PathTemplateMatch
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final T
value

Inherited from io.undertow.util.PathTemplateMatch:
ATTACHMENT_KEY

Constructor Summary

AccessConstructor and Description
public
PathMatchResult(Map<String, String> parameters, String matchedTemplate, T value)

Method Summary

Modifier and TypeMethod and Description
public T
getValue()

Inherited from io.undertow.util.PathTemplateMatch:
getMatchedTemplategetParameters

Field Detail

valueback to summary
private final T value

Constructor Detail

PathMatchResultback to summary
public PathMatchResult(Map<String, String> parameters, String matchedTemplate, T value)

Method Detail

getValueback to summary
public T getValue()
io.undertow.util back to summary

private final Class PathTemplateMatcher.PathTemplateHolder

extends Object
implements Comparable<PathTemplateMatcher<T>.PathTemplateHolder>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable

Field Summary

Modifier and TypeField and Description
pack-priv final PathTemplate
template

pack-priv final T
value

Constructor Summary

AccessConstructor and Description
private
PathTemplateHolder(T value, PathTemplate template)

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(PathTemplateMatcher<T>.PathTemplateHolder
the object to be compared.
o)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

templateback to summary
pack-priv final PathTemplate template
valueback to summary
pack-priv final T value

Constructor Detail

PathTemplateHolderback to summary
private PathTemplateHolder(T value, PathTemplate template)

Method Detail

compareToback to summary
public int compareTo(PathTemplateMatcher<T>.PathTemplateHolder o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
o:PathTemplateMatcher<T>.PathTemplateHolder

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override