Top Description Inners Fields Constructors Methods
org.junit.platform.engine.discovery

public final Class NestedClassSelector

extends Object
implements DiscoverySelector
Class Inheritance
All Implemented Interfaces
org.junit.platform.engine.DiscoverySelector
Annotations
@API
status:STABLE
since:1.6
Static Imports
java.util.stream.Collectors.joining, org.apiguardian.api.API.Status.INTERNAL, .API.Status.MAINTAINED, .API.Status.STABLE

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), org.junit.platform.engine.support.descriptor.ClassSource, ClassSelector

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
private final @Nullable ClassLoader
private final List<ClassSelector>
private final ClassSelector

Constructor Summary

AccessConstructor and Description
pack-priv
NestedClassSelector(@Nullable ClassLoader classLoader, List<String> enclosingClassNames, String nestedClassName)

pack-priv
NestedClassSelector(List<Class<?>> enclosingClasses, Class<?> nestedClass)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public @Nullable ClassLoader

Returns:

the ClassLoader; potentially null
getClassLoader
()

Get the ClassLoader used to load the selected nested class.

public List<Class<?>>
getEnclosingClasses()

Get the list of Class enclosing the selected nested Class.

public List<String>
getEnclosingClassNames()

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

public Class<?>
getNestedClass()

Get the selected nested Class.

public String
getNestedClassName()

Get the name of the selected nested class.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public Optional<DiscoverySelectorIdentifier>
toIdentifier()

Overrides default org.junit.platform.engine.DiscoverySelector.toIdentifier.

Return the identifier of this selector.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

classLoaderback to summary
private final @Nullable ClassLoader classLoader
enclosingClassSelectorsback to summary
private final List<ClassSelector> enclosingClassSelectors
nestedClassSelectorback to summary
private final ClassSelector nestedClassSelector

Constructor Detail

NestedClassSelectorback to summary
pack-priv NestedClassSelector(@Nullable ClassLoader classLoader, List<String> enclosingClassNames, String nestedClassName)
NestedClassSelectorback to summary
pack-priv NestedClassSelector(List<Class<?>> enclosingClasses, Class<?> nestedClass)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
getClassLoaderback to summary
public @Nullable ClassLoader getClassLoader()

Get the ClassLoader used to load the selected nested class.

Returns:@Nullable ClassLoader

the ClassLoader; potentially null

Annotations
@API
status:MAINTAINED
since:1.13.3
Since
1.10
getEnclosingClassesback to summary
public List<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.

getEnclosingClassNamesback to summary
public List<String> getEnclosingClassNames()

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

getNestedClassback to summary
public 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.

getNestedClassNameback to summary
public String getNestedClassName()

Get the name of the selected nested class.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override
toIdentifierback to summary
public Optional<DiscoverySelectorIdentifier> toIdentifier()

Overrides default org.junit.platform.engine.DiscoverySelector.toIdentifier.

Doc from org.junit.platform.engine.DiscoverySelector.toIdentifier.

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.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override
org.junit.platform.engine.discovery back to summary

public Class NestedClassSelector.IdentifierParser

extends Object
implements DiscoverySelectorIdentifierParser
Class Inheritance
  • java.lang.Object
  • org.junit.platform.engine.discovery.NestedClassSelector.IdentifierParser
All Implemented Interfaces
org.junit.platform.engine.discovery.DiscoverySelectorIdentifierParser
Annotations
@API
status:INTERNAL
since:1.11

The DiscoverySelectorIdentifierParser for NestedClassSelectors.

Field Summary

Modifier and TypeField and Description
pack-priv static final String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String
public Optional<NestedClassSelector>
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

PREFIXback to summary
pack-priv static final String PREFIX

Constructor Detail

IdentifierParserback to summary
public IdentifierParser()

Method Detail

getPrefixback to summary
public String getPrefix()

Implements org.junit.platform.engine.discovery.DiscoverySelectorIdentifierParser.getPrefix.

Doc from org.junit.platform.engine.discovery.DiscoverySelectorIdentifierParser.getPrefix.

Get the prefix that this parser supports.

Annotations
@Override
parseback to summary
public Optional<NestedClassSelector> parse(DiscoverySelectorIdentifier identifier, DiscoverySelectorIdentifierParser.Context context)

Implements org.junit.platform.engine.discovery.DiscoverySelectorIdentifierParser.parse.

Doc from org.junit.platform.engine.discovery.DiscoverySelectorIdentifierParser.parse.

Parse the supplied DiscoverySelectorIdentifier.

The JUnit Platform will only invoke this method if the supplied DiscoverySelectorIdentifier has a prefix that matches the value returned by getPrefix().

Annotations
@Override