Package org.eclipse.jetty.http.pathmap

Class PathMappings<E>

java.lang.Object

java.util.AbstractMap<PathSpec,E>

org.eclipse.jetty.http.pathmap.PathMappings<E>

Type Parameters:

E - the type of mapping endpoint

All Implemented Interfaces:

Iterable<MappedResource<E>>, Predicate<String>, Map<PathSpec,E>, Dumpable

@ManagedObject("Path Mappings")
public class PathMappings<E>
extends AbstractMap<PathSpec,E>
implements Iterable<MappedResource<E>>, Dumpable, Predicate<String>

Path Mappings of PathSpec to Resource.

Sorted into search order upon entry into the Set

Nested Class Summary

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

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
PathMappings()

Method Summary

Modifier and Type	Method	Description
String	dump()
void	dump(Appendable out, String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
Set<Map.Entry<PathSpec,E>>	entrySet()
E	get(Object key)
E	get(PathSpec pathSpec)
List<MappedResource<E>>	getMappings()
MatchedResource<E>	getMatched(String path)	Find the best single match for a path.
List<MatchedResource<E>>	getMatchedList(String path)	Return a list of MatchedResource matches for the specified path.
List<MappedResource<E>>	getMatches(String path)	Return a list of MappedResource matches for the specified path.
Iterator<MappedResource<E>>	iterator()
E	put(String pathSpecString, E resource)
E	put(PathSpec pathSpec, E resource)
E	remove(Object key)
E	remove(PathSpec pathSpec)
boolean	removeIf(Predicate<MappedResource<E>> predicate)
void	reset()
int	size()
Stream<MappedResource<E>>	streamResources()
boolean	test(String path)	Test if the mappings contains a specified path.
String	toString()

Methods inherited from class java.util.AbstractMap

clear, clone, containsKey, containsValue, equals, hashCode, isEmpty, keySet, putAll, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface java.util.function.Predicate

and, negate, or

Constructor Details

PathMappings

public PathMappings()

Method Details

entrySet

public Set<Map.Entry<PathSpec,E>> entrySet()

Specified by:

entrySet in interface Map<PathSpec,E>

Specified by:

entrySet in class AbstractMap<PathSpec,E>

dump

public String dump()

Specified by:

dump in interface Dumpable

dump

public void dump(Appendable out,
 String indent)
          throws IOException

Description copied from interface: Dumpable

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Specified by:

dump in interface Dumpable

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

IOException - if unable to write to Appendable

getMappings

@ManagedAttribute(value="mappings",
                  readonly=true)
public List<MappedResource<E>> getMappings()

size

public int size()

Specified by:

size in interface Map<PathSpec,E>

Overrides:

size in class AbstractMap<PathSpec,E>

reset

public void reset()

streamResources

public Stream<MappedResource<E>> streamResources()

removeIf

public boolean removeIf(Predicate<MappedResource<E>> predicate)

getMatchedList

public List<MatchedResource<E>> getMatchedList(String path)

Return a list of MatchedResource matches for the specified path.

Parameters:

path - the path to return matches on

Returns:

the list of mapped resource the path matches on

getMatches

public List<MappedResource<E>> getMatches(String path)

Return a list of MappedResource matches for the specified path.

Parameters:

path - the path to return matches on

Returns:

the list of mapped resource the path matches on

test

public boolean test(String path)

Test if the mappings contains a specified path.

Specified by:

test in interface Predicate<E>

Parameters:

path - the path to return matches on

Returns:

true if the path matches

getMatched

public MatchedResource<E> getMatched(String path)

Find the best single match for a path.

The match may be found by optimized direct lookups when possible, otherwise all mappings are iterated over and the first match returned

Parameters:

path - The path to match

Returns:

A MatchedResource instance or null if no mappings matched.

See Also:

• getMatchedIteratively(String)

iterator

public Iterator<MappedResource<E>> iterator()

Specified by:

iterator in interface Iterable<E>

get

public E get(Object key)

Specified by:

get in interface Map<PathSpec,E>

Overrides:

get in class AbstractMap<PathSpec,E>

get

public E get(PathSpec pathSpec)

put

public E put(String pathSpecString,
 E resource)

put

public E put(PathSpec pathSpec,
 E resource)

Specified by:

put in interface Map<PathSpec,E>

Overrides:

put in class AbstractMap<PathSpec,E>

remove

public E remove(Object key)

Specified by:

remove in interface Map<PathSpec,E>

Overrides:

remove in class AbstractMap<PathSpec,E>

remove

public E remove(PathSpec pathSpec)

toString

public String toString()

Overrides:

toString in class AbstractMap<PathSpec,E>