Class NestedMethodSelector

java.lang.Object

org.junit.platform.engine.discovery.NestedMethodSelector

All Implemented Interfaces:

DiscoverySelector

@API(status=STABLE,
     since="1.6")
public final class NestedMethodSelector
extends Object
implements DiscoverySelector

A DiscoverySelector that selects a nested Method or a combination of enclosing class names, class name, method name, and parameter types so that TestEngines can discover tests or containers based on methods.

If a Java Method is provided, the selector will return that method and its method name, class name, enclosing class names, and parameter types accordingly. If class names or method names are provided, this selector will only attempt to lazily load a class or method if getEnclosingClasses(), getNestedClass(), getMethod(), or getParameterTypes() is invoked.

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

Since:

1.6

See Also:

• DiscoverySelectors.selectNestedMethod(List, String, String)
• DiscoverySelectors.selectNestedMethod(List, String, String, String)
• DiscoverySelectors.selectNestedMethod(List, Class, String)
• DiscoverySelectors.selectNestedMethod(List, Class, String, String)
• DiscoverySelectors.selectNestedMethod(List, Class, Method)
• MethodSource
• NestedClassSelector
• MethodSelector

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NestedMethodSelector.IdentifierParser	The DiscoverySelectorIdentifierParser for NestedMethodSelectors.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@Nullable ClassLoader	getClassLoader()	Get the ClassLoader used to load the nested class.
List<Class<?>>	getEnclosingClasses()	Get the list of Class enclosing the nested Class containing the selected Method.
List<String>	getEnclosingClassNames()	Get the names of the classes enclosing the nested class containing the selected method.
Method	getMethod()	Get the selected Method.
String	getMethodName()	Get the name of the selected method.
Class<?>	getNestedClass()	Get the nested Class containing the selected Method.
String	getNestedClassName()	Get the name of the nested class containing the selected method.
String	getParameterTypeNames()	Get the names of parameter types for the selected method as a String.
Class<?>[]	getParameterTypes()	Get the parameter types for the selected method.
int	hashCode()
Optional<DiscoverySelectorIdentifier>	toIdentifier()	Return the identifier of this selector.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getClassLoader

@API(status=MAINTAINED,
     since="1.13.3")
public @Nullable ClassLoader getClassLoader()

Get the ClassLoader used to load the nested class.

Since:

1.10

getEnclosingClassNames

public List<String> getEnclosingClassNames()

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

getEnclosingClasses

public List<Class<?>> getEnclosingClasses()

Get the list of Class enclosing the nested Class containing the selected Method.

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 String getNestedClassName()

Get the name of the nested class containing the selected method.

getNestedClass

public Class<?> getNestedClass()

Get the nested Class containing the selected Method.

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.

getMethodName

public String getMethodName()

Get the name of the selected method.

getMethod

public Method getMethod()

Get the selected Method.

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

getParameterTypeNames

@API(status=STABLE,
     since="1.10")
public String getParameterTypeNames()

Get the names of parameter types for the selected method as a String.

See MethodSelector.getParameterTypeNames() for details.

Returns:

the names of parameter types supplied to this NestedMethodSelector via a constructor or deduced from a Method or parameter types supplied via a constructor; never null but potentially an empty string

Since:

1.10

See Also:

• MethodSelector.getParameterTypeNames()

getParameterTypes

@API(status=MAINTAINED,
     since="1.13.3")
public Class<?>[] getParameterTypes()

Get the parameter types for the selected method.

See MethodSelector.getParameterTypes() for details.

Returns:

the method's parameter types; never null but potentially an empty array if the selected method does not declare parameters

Since:

1.10

See Also:

• getParameterTypeNames()
• MethodSelector.getParameterTypes()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toIdentifier

public 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