Package org.junit.platform.engine.discovery

Class ClassSelector

java.lang.Object

org.junit.platform.engine.discovery.ClassSelector

All Implemented Interfaces:

DiscoverySelector

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

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

If a Java Class reference is provided, the selector will return that Class and its class name accordingly. If a class name is provided, the selector will only attempt to lazily load the Class if getJavaClass() 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.0

See Also:

DiscoverySelectors.selectClass(String), DiscoverySelectors.selectClass(Class), ClassSource

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClassSelector.IdentifierParser	The DiscoverySelectorIdentifierParser for ClassSelectors.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.ClassLoader	classLoader
private java.lang.String	className
private java.lang.Class<?>	javaClass

Constructor Summary

Constructors

Constructor	Description
ClassSelector(java.lang.Class<?> javaClass)
ClassSelector(java.lang.ClassLoader classLoader, java.lang.String className)

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 class.
java.lang.String	getClassName()	Get the selected class name.
java.lang.Class<?>	getJavaClass()	Get the selected 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

className

private final java.lang.String className

javaClass

private java.lang.Class<?> javaClass

Constructor Detail

ClassSelector

ClassSelector(java.lang.ClassLoader classLoader,
              java.lang.String className)

ClassSelector

ClassSelector(java.lang.Class<?> javaClass)

Method Detail

getClassLoader

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

Get the ClassLoader used to load the selected class.

Returns:

the ClassLoader; potentially null

Since:

1.10

getClassName

public java.lang.String getClassName()

Get the selected class name.

getJavaClass

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

Get the selected Class.

If the Class was not provided, but only the name, this method attempts to lazily load the Class based on its name and throws a PreconditionViolationException if the class cannot be loaded.

equals

@API(status=STABLE,
     since="1.3")
public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

Since:

1.3

hashCode

@API(status=STABLE,
     since="1.3")
public int hashCode()

Overrides:

hashCode in class java.lang.Object

Since:

1.3

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