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

public final Class MethodSelector

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

A DiscoverySelector that selects a Method or a combination of 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, and parameter types accordingly. If a Class and method name, a class name and method name, or a fully qualified method name is provided, this selector will only attempt to lazily load the class, method, or parameter types if getJavaClass(), getJavaMethod(), 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.0
See Also
DiscoverySelectors#selectMethod(String), DiscoverySelectors#selectMethod(String, String), DiscoverySelectors#selectMethod(String, String, String), DiscoverySelectors#selectMethod(Class, String), DiscoverySelectors#selectMethod(Class, String, String), DiscoverySelectors#selectMethod(Class, Method), org.junit.platform.engine.support.descriptor.MethodSource

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 String
private volatile @Nullable Class<?>
private volatile @Nullable Method
private final String
private final String
private volatile @Nullable Class<?>[]

Constructor Summary

AccessConstructor and Description
pack-priv
MethodSelector(@Nullable ClassLoader classLoader, String className, String methodName, String parameterTypeNames)

pack-priv
MethodSelector(Class<?> javaClass, String methodName, String parameterTypeNames)

pack-priv
MethodSelector(@Nullable ClassLoader classLoader, String className, String methodName, Class<?>... parameterTypes)

pack-priv
MethodSelector(Class<?> javaClass, String methodName, Class<?>... parameterTypes)

pack-priv
MethodSelector(Class<?> javaClass, Method method)

private
MethodSelector(Class<?> javaClass, Method method, Class<?>... parameterTypes)

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

public String
getClassName()

Get the selected class name.

public Class<?>
getJavaClass()

Get the Class in which the selected method is declared, or a subclass thereof.

public Method
getJavaMethod()

Get the selected Method.

public String
getMethodName()

Get the selected method name.

public String

Returns:

the names of parameter types supplied to this MethodSelector 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, typically a comma-separated list of primitive types, fully qualified class names, or array types.

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.

private Class<?>
private Method
private Class<?>[]
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
classNameback to summary
private final String className
javaClassback to summary
private volatile @Nullable Class<?> javaClass
javaMethodback to summary
private volatile @Nullable Method javaMethod
methodNameback to summary
private final String methodName
parameterTypeNamesback to summary
private final String parameterTypeNames
parameterTypesback to summary
private volatile @Nullable Class<?>[] parameterTypes

Constructor Detail

MethodSelectorback to summary
pack-priv MethodSelector(@Nullable ClassLoader classLoader, String className, String methodName, String parameterTypeNames)
Since
1.10
MethodSelectorback to summary
pack-priv MethodSelector(Class<?> javaClass, String methodName, String parameterTypeNames)
MethodSelectorback to summary
pack-priv MethodSelector(@Nullable ClassLoader classLoader, String className, String methodName, Class<?>... parameterTypes)
Since
1.10
MethodSelectorback to summary
pack-priv MethodSelector(Class<?> javaClass, String methodName, Class<?>... parameterTypes)
Since
1.10
MethodSelectorback to summary
pack-priv MethodSelector(Class<?> javaClass, Method method)
MethodSelectorback to summary
private MethodSelector(Class<?> javaClass, Method method, Class<?>... parameterTypes)

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
@API
status:STABLE
since:1.3
@Override
Since
1.3
getClassLoaderback to summary
public @Nullable ClassLoader getClassLoader()

Get the ClassLoader used to load the specified class.

Returns:@Nullable ClassLoader

the ClassLoader; potentially null

Annotations
@API
status:MAINTAINED
since:1.13.3
Since
1.10
getClassNameback to summary
public String getClassName()

Get the selected class name.

getJavaClassback to summary
public Class<?> getJavaClass()

Get the Class in which the selected method is declared, or a subclass thereof.

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.

See Also
getJavaMethod()
getJavaMethodback to summary
public Method getJavaMethod()

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.

See Also
getJavaClass()
getMethodNameback to summary
public String getMethodName()

Get the selected method name.

getParameterTypeNamesback to summary
public String getParameterTypeNames()

Get the names of parameter types for the selected method as a String, typically a comma-separated list of primitive types, fully qualified class names, or array types.

Note

the names of parameter types are provided as a single string instead of a collection in order to allow this selector to be used in a generic fashion by various test engines. It is therefore the responsibility of the caller of this method to determine how to parse the returned string.

Returns:String

the names of parameter types supplied to this MethodSelector 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
getParameterTypes()
getParameterTypesback to summary
public Class<?>[] getParameterTypes()

Get the parameter types for the selected method.

If the parameter types were not provided as Class references (or could not be deduced as Class references in the constructor), this method attempts to lazily load the class reference for each parameter type based on its name and throws a JUnitException if the class cannot be loaded.

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(), Method#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
@API
status:STABLE
since:1.3
@Override
Since
1.3
lazyLoadJavaClassback to summary
private Class<?> lazyLoadJavaClass()
lazyLoadJavaMethodback to summary
private Method lazyLoadJavaMethod()
lazyLoadParameterTypesback to summary
private Class<?>[] lazyLoadParameterTypes()
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 MethodSelector.IdentifierParser

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

The DiscoverySelectorIdentifierParser for MethodSelectors.

Field Summary

Modifier and TypeField and Description
private static final String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String
public Optional<MethodSelector>
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<MethodSelector> 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