Package org.junit.platform.engine.discovery

Class NestedClassSelector

java.lang.Object

org.junit.platform.engine.discovery.NestedClassSelector

All Implemented Interfaces:

DiscoverySelector

@API(status=STABLE,
     since="1.6")
public class NestedClassSelector
extends java.lang.Object
implements DiscoverySelector

A DiscoverySelector that selects a nested Class or class name enclosed in other classes so that TestEngines can discover tests or containers based on classes.

If Java Class references are provided for the nested class or the enclosing classes, the selector will return those classes and their class names accordingly. If class names are provided, the selector will only attempt to lazily load classes if getEnclosingClasses() or getNestedClass() is invoked.

In this context, Java Class means anything that can be referenced as a Class on the JVM — for example, classes from other JVM languages such Groovy, Scala, etc.

Since:

1.6

See Also:

DiscoverySelectors.selectNestedClass(List, Class), DiscoverySelectors.selectNestedClass(List, String), ClassSource, ClassSelector

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NestedClassSelector.IdentifierParser	The DiscoverySelectorIdentifierParser for NestedClassSelectors.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.ClassLoader	classLoader
private java.util.List<ClassSelector>	enclosingClassSelectors
private ClassSelector	nestedClassSelector

Constructor Summary

Constructors

Constructor	Description
NestedClassSelector(java.lang.ClassLoader classLoader, java.util.List<java.lang.String> enclosingClassNames, java.lang.String nestedClassName)
NestedClassSelector(java.util.List<java.lang.Class<?>> enclosingClasses, java.lang.Class<?> nestedClass)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.ClassLoader	getClassLoader()	Get the ClassLoader used to load the selected nested class.
java.util.List<java.lang.Class<?>>	getEnclosingClasses()	Get the list of Class enclosing the selected nested Class.
java.util.List<java.lang.String>	getEnclosingClassNames()	Get the names of the classes enclosing the selected nested class.
java.lang.Class<?>	getNestedClass()	Get the selected nested Class.
java.lang.String	getNestedClassName()	Get the name of the selected nested class.
int	hashCode()
java.util.Optional<DiscoverySelectorIdentifier>	toIdentifier()	Return the identifier of this selector.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

classLoader

private final java.lang.ClassLoader classLoader

enclosingClassSelectors

private final java.util.List<ClassSelector> enclosingClassSelectors

nestedClassSelector

private final ClassSelector nestedClassSelector

Constructor Detail

NestedClassSelector

NestedClassSelector(java.lang.ClassLoader classLoader,
                    java.util.List<java.lang.String> enclosingClassNames,
                    java.lang.String nestedClassName)

NestedClassSelector

NestedClassSelector(java.util.List<java.lang.Class<?>> enclosingClasses,
                    java.lang.Class<?> nestedClass)

Method Detail

getClassLoader

@API(status=MAINTAINED,
     since="1.13.3")
public java.lang.ClassLoader getClassLoader()

Get the ClassLoader used to load the selected nested class.

Returns:

the ClassLoader; potentially null

Since:

1.10

getEnclosingClassNames

public java.util.List<java.lang.String> getEnclosingClassNames()

Get the names of the classes enclosing the selected nested class.

getEnclosingClasses

public java.util.List<java.lang.Class<?>> getEnclosingClasses()

Get the list of Class enclosing the selected nested Class.

If the Class were not provided, but only the name of the nested class and its enclosing classes, this method attempts to lazily load the list of enclosing Class and throws a PreconditionViolationException if the classes cannot be loaded.

getNestedClassName

public java.lang.String getNestedClassName()

Get the name of the selected nested class.

getNestedClass

public java.lang.Class<?> getNestedClass()

Get the selected nested Class.

If the Class were not provided, but only the name of the nested class and its enclosing classes, this method attempts to lazily load the nested Class and throws a PreconditionViolationException if the class cannot be loaded.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toIdentifier

public java.util.Optional<DiscoverySelectorIdentifier> toIdentifier()

Description copied from interface: DiscoverySelector

Return the identifier of this selector.

The returned identifier must be parsable by a corresponding DiscoverySelectorIdentifierParser.

The default implementation returns Optional.empty(). Can be overridden by concrete implementations.

Specified by:

toIdentifier in interface DiscoverySelector

Returns:

an Optional containing the identifier of this selector; never null but potentially empty if the selector does not support identifiers