Class ClassMatcher

java.lang.Object

java.util.AbstractCollection<String>

java.util.AbstractSet<String>

org.eclipse.jetty.util.ClassMatcher

All Implemented Interfaces:

Iterable<String>, Collection<String>, Set<String>

Direct Known Subclasses:

ClassMatcher, ClassMatcher, ClassMatcher

public class ClassMatcher
extends AbstractSet<String>

A matcher for classes based on package and/or location and/or module/

Performs pattern matching of a class against a set of pattern entries. A class pattern is a string of one of the forms:

• 'org.package.SomeClass' will match a specific class
• 'org.package.' will match a specific package hierarchy
• 'org.package.SomeClass$NestedClass ' will match a nested class exactly otherwise. Nested classes are matched by their containing class. (eg. org.example.MyClass matches org.example.MyClass$AnyNestedClass)
• 'file:///some/location/' - A file system directory from which the class was loaded
• 'file:///some/location.jar' - The URI of a jar file from which the class was loaded
• 'jrt:/modulename' - A Java9 module name
• Any of the above patterns preceded by '-' will exclude rather than include the match.

When class is initialized from a classpath pattern string, entries in this string should be separated by ':' (semicolon) or ',' (comma).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClassMatcher.ByClass
static class	ClassMatcher.ByLocation
static class	ClassMatcher.ByLocationOrModule
static class	ClassMatcher.ByModule
static class	ClassMatcher.ByPackage
static class	ClassMatcher.ByPackageOrName
protected static interface	ClassMatcher.Constructor<T extends ClassMatcher>	Deprecated.
static class	ClassMatcher.Entry

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String, ClassMatcher.Entry>	_entries
protected final IncludeExcludeSet<ClassMatcher.Entry, URI>	_locations
protected final IncludeExcludeSet<ClassMatcher.Entry, String>	_patterns

Constructor Summary

Constructors

Modifier	Constructor	Description
	ClassMatcher()
	ClassMatcher(String pattern)
	ClassMatcher(String... patterns)
protected	ClassMatcher(Map<String, ClassMatcher.Entry> entries, IncludeExcludeSet<ClassMatcher.Entry, String> patterns, IncludeExcludeSet<ClassMatcher.Entry, URI> locations)
	ClassMatcher(ClassMatcher patterns)

Method Summary

Modifier and Type	Method	Description
boolean	add(String pattern)
boolean	add(String... pattern)
protected boolean	add(ClassMatcher.Entry entry)
ClassMatcher	asImmutable()
void	clear()
boolean	exclude(String name)
boolean	exclude(String... name)
String[]	getExclusions()
String[]	getInclusions()
String[]	getPatterns()
boolean	include(String name)
boolean	include(String... name)
Iterator<String>	iterator()
boolean	match(Class<?> clazz)	Match the class name against the pattern
boolean	match(String name)	Match the class name against the pattern
boolean	match(String name, URL url)
protected ClassMatcher.Entry	newEntry(String pattern)
protected ClassMatcher.Entry	newEntry(String name, boolean inclusive)
boolean	remove(Object o)
int	size()
protected static <T extends ClassMatcher> T	wrap(ClassMatcher matcher, ClassMatcher.Constructor<T> constructor)	Deprecated. use ClassMatcher directly.

Methods inherited from class AbstractSet

equals, hashCode, removeAll

Methods inherited from class AbstractCollection

addAll, contains, containsAll, isEmpty, retainAll, toArray, toArray, toString

Methods inherited from class Object

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

Methods inherited from interface Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface Iterable

forEach

Methods inherited from interface Set

addAll, contains, containsAll, isEmpty, retainAll, spliterator, toArray, toArray

Field Details

_entries

protected final Map<String, ClassMatcher.Entry> _entries

_patterns

protected final IncludeExcludeSet<ClassMatcher.Entry, String> _patterns

_locations

protected final IncludeExcludeSet<ClassMatcher.Entry, URI> _locations

Constructor Details

ClassMatcher

protected ClassMatcher(Map<String, ClassMatcher.Entry> entries,
 IncludeExcludeSet<ClassMatcher.Entry, String> patterns,
 IncludeExcludeSet<ClassMatcher.Entry, URI> locations)

ClassMatcher

public ClassMatcher()

ClassMatcher

public ClassMatcher(ClassMatcher patterns)

ClassMatcher

public ClassMatcher(String... patterns)

ClassMatcher

public ClassMatcher(String pattern)

Method Details

wrap

@Deprecated
protected static <T extends ClassMatcher> T wrap(ClassMatcher matcher,
 ClassMatcher.Constructor<T> constructor)

Deprecated.

use ClassMatcher directly.

Wrap an instance of a ClassMatcher using a constructor of an extended ClassMatcher that needs access to the internal fields of the passed matcher.

Type Parameters:

T - The type of the API specific wrapper

Parameters:

matcher - The matcher to wrap

constructor - The constructor to build the API specific wrapper

Returns:

A wrapper of the matcher, sharing internal state.

asImmutable

public ClassMatcher asImmutable()

include

public boolean include(String name)

include

public boolean include(String... name)

exclude

public boolean exclude(String name)

exclude

public boolean exclude(String... name)

add

public boolean add(String pattern)

Specified by:

add in interface Collection<String>

Specified by:

add in interface Set<String>

Overrides:

add in class AbstractCollection<String>

add

public boolean add(String... pattern)

add

protected boolean add(ClassMatcher.Entry entry)

newEntry

protected ClassMatcher.Entry newEntry(String pattern)

newEntry

protected ClassMatcher.Entry newEntry(String name,
 boolean inclusive)

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<String>

Specified by:

remove in interface Set<String>

Overrides:

remove in class AbstractCollection<String>

clear

public void clear()

Specified by:

clear in interface Collection<String>

Specified by:

clear in interface Set<String>

Overrides:

clear in class AbstractCollection<String>

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Collection<String>

Specified by:

iterator in interface Iterable<String>

Specified by:

iterator in interface Set<String>

Specified by:

iterator in class AbstractCollection<String>

size

public int size()

Specified by:

size in interface Collection<String>

Specified by:

size in interface Set<String>

Specified by:

size in class AbstractCollection<String>

getPatterns

public String[] getPatterns()

Returns:

array of classpath patterns

getInclusions

public String[] getInclusions()

Returns:

array of inclusive classpath patterns

getExclusions

public String[] getExclusions()

Returns:

array of excluded classpath patterns (without '-' prefix)

match

public boolean match(String name)

Match the class name against the pattern

Parameters:

name - name of the class to match

Returns:

true if class matches the pattern

match

public boolean match(Class<?> clazz)

Match the class name against the pattern

Parameters:

clazz - A class to try to match

Returns:

true if class matches the pattern

match

public boolean match(String name,
 URL url)