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

public final Class NestedMethodSelector

extends Object
implements DiscoverySelector
Class Inheritance
All Implemented Interfaces
org.junit.platform.engine.DiscoverySelector
Annotations
@API
status:STABLE
since:1.6
Static Imports
org.apiguardian.api.API.Status.INTERNAL, .API.Status.MAINTAINED, .API.Status.STABLE
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), org.junit.platform.engine.support.descriptor.MethodSource, NestedClassSelector, MethodSelector

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
NestedMethodSelector.IdentifierParser

The DiscoverySelectorIdentifierParser for NestedMethodSelectors.

Field Summary

Modifier and TypeField and Description
private final MethodSelector
methodSelector

private final NestedClassSelector
nestedClassSelector

Constructor Summary

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

pack-priv
NestedMethodSelector(@Nullable ClassLoader classLoader, List<String> enclosingClassNames, String nestedClassName, String methodName, Class<?>... parameterTypes)

pack-priv
NestedMethodSelector(List<Class<?>> enclosingClasses, Class<?> nestedClass, String methodName, String parameterTypeNames)

pack-priv
NestedMethodSelector(List<Class<?>> enclosingClasses, Class<?> nestedClass, String methodName, Class<?>... parameterTypes)

pack-priv
NestedMethodSelector(List<Class<?>> enclosingClasses, Class<?> nestedClass, Method method)

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
getClassLoader()

Get the ClassLoader used to load the nested class.

public List<Class<?>>
getEnclosingClasses()

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

public List<String>
getEnclosingClassNames()

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

public Method
getMethod()

Get the selected Method.

public String
getMethodName()

Get the name of the selected method.

public Class<?>
getNestedClass()

Get the nested Class containing the selected Method.

public String
getNestedClassName()

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

public String

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
getParameterTypeNames()

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

public Class<?>[]

Returns:

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

Get the parameter types for the selected method.

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

methodSelectorback to summary
private final MethodSelector methodSelector
nestedClassSelectorback to summary
private final NestedClassSelector nestedClassSelector

Constructor Detail

NestedMethodSelectorback to summary
pack-priv NestedMethodSelector(@Nullable ClassLoader classLoader, List<String> enclosingClassNames, String nestedClassName, String methodName, String parameterTypeNames)
NestedMethodSelectorback to summary
pack-priv NestedMethodSelector(@Nullable ClassLoader classLoader, List<String> enclosingClassNames, String nestedClassName, String methodName, Class<?>... parameterTypes)
Since
1.10
NestedMethodSelectorback to summary
pack-priv NestedMethodSelector(List<Class<?>> enclosingClasses, Class<?> nestedClass, String methodName, String parameterTypeNames)
NestedMethodSelectorback to summary
pack-priv NestedMethodSelector(List<Class<?>> enclosingClasses, Class<?> nestedClass, String methodName, Class<?>... parameterTypes)
Since
1.10
NestedMethodSelectorback to summary
pack-priv NestedMethodSelector(List<Class<?>> enclosingClasses, Class<?> nestedClass, Method method)

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 nested class.

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 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.

getEnclosingClassNamesback to summary
public List<String> getEnclosingClassNames()

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

getMethodback to summary
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.

getMethodNameback to summary
public String getMethodName()

Get the name of the selected method.

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

getNestedClassNameback to summary
public String getNestedClassName()

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

getParameterTypeNamesback to summary
public String getParameterTypeNames()

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

See MethodSelector#getParameterTypeNames() for details.

Returns:String

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

Annotations
@API
status:STABLE
since:1.10
Since
1.10
See Also
MethodSelector#getParameterTypeNames()
getParameterTypesback to summary
public Class<?>[] getParameterTypes()

Get the parameter types for the selected method.

See MethodSelector#getParameterTypes() for details.

Returns:Class<?>[]

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

Annotations
@API
status:MAINTAINED
since:1.13.3
Since
1.10
See Also
getParameterTypeNames(), MethodSelector#getParameterTypes()
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 NestedMethodSelector.IdentifierParser

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

Field Summary

Modifier and TypeField and Description
private static final String
PREFIX

Constructor Summary

AccessConstructor and Description
public
IdentifierParser()

Method Summary

Modifier and TypeMethod and Description
public String
getPrefix()

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

Get the prefix that this parser supports.

public Optional<NestedMethodSelector>
parse(DiscoverySelectorIdentifier identifier, DiscoverySelectorIdentifierParser.Context context)

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

Parse the supplied DiscoverySelectorIdentifier.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

PREFIXback to summary
private 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<NestedMethodSelector> 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