org.eclipse.jetty.webapp

Class ClasspathPattern

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<String>

org.eclipse.jetty.webapp.ClasspathPattern

All Implemented Interfaces:

Iterable<String>, Collection<String>, List<String>

public class ClasspathPattern
extends AbstractList<String>

Classpath classes list performs sequential pattern matching of a class name against an internal array of classpath 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.Classname' excludes a specific class
• '-org.package.' excludes a specific package hierarchy
• Nested classes must be specified with the '$' separator if they are to be explicitly included or excluded (eg. org.example.MyClass$NestedClass).
• Nested classes are matched by their containing class. (eg. -org.example.MyClass would exclude org.example.MyClass$AnyNestedClass)

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

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ClasspathPattern()
ClasspathPattern(String pattern)
ClasspathPattern(String[] patterns)

Method Summary

Modifier and Type	Method and Description
void	add(int index, String element)
void	addAfter(String afterPattern, String... patterns)
void	addBefore(String beforePattern, String... patterns)
void	addPattern(String element) Deprecated.
String	get(int index)
List<String>	getClasses()
String[]	getPatterns()
boolean	match(String name) Match the class name against the pattern
void	prepend(String[] classes)
void	prependPattern(String pattern)
String	remove(int index)
boolean	remove(String pattern)
String	set(int index, String element)
int	size()

Methods inherited from class java.util.AbstractList

add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ClasspathPattern

public ClasspathPattern()

ClasspathPattern

public ClasspathPattern(String[] patterns)

ClasspathPattern

public ClasspathPattern(String pattern)

Method Detail

get

public String get(int index)

Specified by:

get in interface List<String>

Specified by:

get in class AbstractList<String>

set

public String set(int index,
                  String element)

Specified by:

set in interface List<String>

Overrides:

set in class AbstractList<String>

add

public void add(int index,
                String element)

Specified by:

add in interface List<String>

Overrides:

add in class AbstractList<String>

addPattern

@Deprecated
public void addPattern(String element)

Deprecated.

remove

public String remove(int index)

Specified by:

remove in interface List<String>

Overrides:

remove in class AbstractList<String>

remove

public boolean remove(String pattern)

size

public int size()

Specified by:

size in interface Collection<String>

Specified by:

size in interface List<String>

Specified by:

size in class AbstractCollection<String>

prepend

public void prepend(String[] classes)

Parameters:

classes - array of classpath patterns

prependPattern

public void prependPattern(String pattern)

getPatterns

public String[] getPatterns()

Returns:

array of classpath patterns

getClasses

public List<String> getClasses()

Returns:

List of classes excluded class exclusions and package patterns

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

addAfter

public void addAfter(String afterPattern,
                     String... patterns)

addBefore

public void addBefore(String beforePattern,
                      String... patterns)