Top Description Fields Constructors Methods
org.junit.platform.engine.support.descriptor

public final Class MethodSource

extends Object
implements TestSource
Class Inheritance
All Implemented Interfaces
org.junit.platform.engine.TestSource, java.io.Serializable
Annotations
@API
status:STABLE
since:1.0
Static Imports
org.apiguardian.api.API.Status.STABLE, org.junit.platform.commons.util.ClassUtils.nullSafeToString
Method based TestSource.

This class stores the method name along with the names of its parameter types because Method does not implement java.io.Serializable.

Since
1.0
See Also
org.junit.platform.engine.discovery.MethodSelector

Field Summary

Modifier and TypeField and Description
private final String
className

private @Nullable Class<?>
javaClass

private transient @Nullable Method
javaMethod

private final String
methodName

private final @Nullable String
methodParameterTypes

private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
private
MethodSource(String className, String methodName)

private
MethodSource(String className, String methodName, @Nullable String methodParameterTypes)

private
MethodSource(Method testMethod)

private
MethodSource(Class<?> testClass, Method testMethod)

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 static MethodSource
from(String
the class name; must not be null or blank
className, String
the method name; must not be null or blank
methodName)

Create a new MethodSource using the supplied class name and method name.

public static MethodSource
from(String
the class name; must not be null or blank
className, String
the method name; must not be null or blank
methodName, String
a comma-separated list of fully qualified class names representing the method parameter types
methodParameterTypes)

Create a new MethodSource using the supplied class name, method name, and method parameter types.

public static MethodSource
from(String
the class name; must not be null or blank
className, String
the method name; must not be null or blank
methodName, Class<?>...
a varargs array of classes representing the method parameter types
methodParameterTypes)

Create a new MethodSource using the supplied class name, method name, and method parameter types.

public static MethodSource
from(Method
the Java method; must not be null
testMethod)

Create a new MethodSource using the supplied method.

public static MethodSource
from(Class<?>
the Java class; must not be null
testClass, Method
the Java method; must not be null
testMethod)

Create a new MethodSource using the supplied class and method.

public String
getClassName()

Get the class name of this source.

public Class<?>
getJavaClass()

Get the Java class of this source.

public Method
getJavaMethod()

Get the Java method of this source.

public String
getMethodName()

Get the method name of this source.

public @Nullable String
getMethodParameterTypes()

Get the method parameter types of this source.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

private Class<?>
lazyLoadJavaClass()

private Method
lazyLoadJavaMethod()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

classNameback to summary
private final String className
javaClassback to summary
private @Nullable Class<?> javaClass
javaMethodback to summary
private transient @Nullable Method javaMethod
methodNameback to summary
private final String methodName
methodParameterTypesback to summary
private final @Nullable String methodParameterTypes
serialVersionUIDback to summary
private static final long serialVersionUID
Annotations
@Serial

Constructor Detail

MethodSourceback to summary
private MethodSource(String className, String methodName)
MethodSourceback to summary
private MethodSource(String className, String methodName, @Nullable String methodParameterTypes)
MethodSourceback to summary
private MethodSource(Method testMethod)
MethodSourceback to summary
private MethodSource(Class<?> testClass, Method testMethod)
Since
1.3

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
fromback to summary
public static MethodSource from(String className, String methodName)

Create a new MethodSource using the supplied class name and method name.

Parameters
className:String

the class name; must not be null or blank

methodName:String

the method name; must not be null or blank

fromback to summary
public static MethodSource from(String className, String methodName, String methodParameterTypes)

Create a new MethodSource using the supplied class name, method name, and method parameter types.

Parameters
className:String

the class name; must not be null or blank

methodName:String

the method name; must not be null or blank

methodParameterTypes:String

a comma-separated list of fully qualified class names representing the method parameter types

fromback to summary
public static MethodSource from(String className, String methodName, Class<?>... methodParameterTypes)

Create a new MethodSource using the supplied class name, method name, and method parameter types.

Parameters
className:String

the class name; must not be null or blank

methodName:String

the method name; must not be null or blank

methodParameterTypes:Class<?>[]

a varargs array of classes representing the method parameter types

Annotations
@API
status:STABLE
since:1.5
Since
1.5
fromback to summary
public static MethodSource from(Method testMethod)

Create a new MethodSource using the supplied method.

Parameters
testMethod:Method

the Java method; must not be null

See Also
from(Class, Method)
fromback to summary
public static MethodSource from(Class<?> testClass, Method testMethod)

Create a new MethodSource using the supplied class and method.

This method should be used in favor of from(Method) if the test method is inherited from a superclass or present as an interface default method.

Parameters
testClass:Class<?>

the Java class; must not be null

testMethod:Method

the Java method; must not be null

Annotations
@API
status:STABLE
since:1.3
Since
1.3
getClassNameback to summary
public String getClassName()

Get the class name of this source.

getJavaClassback to summary
public Class<?> getJavaClass()

Get the Java class of this source.

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.

Annotations
@API
status:STABLE
since:1.7
Since
1.7
See Also
getClassName()
getJavaMethodback to summary
public Method getJavaMethod()

Get the Java method of this source.

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.

Annotations
@API
status:STABLE
since:1.7
Since
1.7
See Also
getMethodName()
getMethodNameback to summary
public String getMethodName()

Get the method name of this source.

getMethodParameterTypesback to summary
public @Nullable String getMethodParameterTypes()

Get the method parameter types of this source.

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
lazyLoadJavaClassback to summary
private Class<?> lazyLoadJavaClass()
lazyLoadJavaMethodback to summary
private Method lazyLoadJavaMethod()
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