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

public final Class ClassSource

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
Class based TestSource with an optional file position.

If a Java Class reference is provided, the ClassSource will contain that Class and its class name accordingly. If a class name is provided, the ClassSource will contain the class name and will only attempt to lazily load the Class if getJavaClass() 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.0
See Also
org.junit.platform.engine.discovery.ClassSelector

Field Summary

Modifier and TypeField and Description
public static final String
CLASS_SCHEME

URI scheme for class sources:

private final String
className

private final @Nullable FilePosition
filePosition

private @Nullable Class<?>
javaClass

private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
private
ClassSource(String className)

private
ClassSource(String className, @Nullable FilePosition filePosition)

private
ClassSource(Class<?> javaClass)

private
ClassSource(Class<?> javaClass, @Nullable FilePosition filePosition)

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 ClassSource
from(String
the class name; must not be null or blank
className)

Create a new ClassSource using the supplied class name.

public static ClassSource
from(String
the class name; must not be null or blank
className, @Nullable FilePosition
the position in the source file; may be null
filePosition)

Create a new ClassSource using the supplied class name and file position.

public static ClassSource
from(Class<?>
the Java class; must not be null
javaClass)

Create a new ClassSource using the supplied class.

public static ClassSource
from(Class<?>
the Java class; must not be null
javaClass, FilePosition
the position in the Java source file; may be null
filePosition)

Create a new ClassSource using the supplied class and file position.

public static ClassSource

Returns:

a new ClassSource; never null
from(URI
the URI for the class source; never null
uri)

Create a new ClassSource from the supplied URI.

public String
getClassName()

Get the class name of this source.

public Class<?>
getJavaClass()

Get the Java class of this source.

public Optional<FilePosition>
getPosition()

Get the position in the source file for the associated class, if available.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

CLASS_SCHEMEback to summary
public static final String CLASS_SCHEME

URI scheme for class sources:

Annotations
@API
status:STABLE
since:1.8
Since
1.8
classNameback to summary
private final String className
filePositionback to summary
private final @Nullable FilePosition filePosition
javaClassback to summary
private @Nullable Class<?> javaClass
serialVersionUIDback to summary
private static final long serialVersionUID
Annotations
@Serial

Constructor Detail

ClassSourceback to summary
private ClassSource(String className)
ClassSourceback to summary
private ClassSource(String className, @Nullable FilePosition filePosition)
ClassSourceback to summary
private ClassSource(Class<?> javaClass)
ClassSourceback to summary
private ClassSource(Class<?> javaClass, @Nullable FilePosition filePosition)

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 ClassSource from(String className)

Create a new ClassSource using the supplied class name.

Parameters
className:String

the class name; must not be null or blank

fromback to summary
public static ClassSource from(String className, @Nullable FilePosition filePosition)

Create a new ClassSource using the supplied class name and file position.

Parameters
className:String

the class name; must not be null or blank

filePosition:@Nullable FilePosition

the position in the source file; may be null

fromback to summary
public static ClassSource from(Class<?> javaClass)

Create a new ClassSource using the supplied class.

Parameters
javaClass:Class<?>

the Java class; must not be null

fromback to summary
public static ClassSource from(Class<?> javaClass, FilePosition filePosition)

Create a new ClassSource using the supplied class and file position.

Parameters
javaClass:Class<?>

the Java class; must not be null

filePosition:FilePosition

the position in the Java source file; may be null

fromback to summary
public static ClassSource from(URI uri)

Create a new ClassSource from the supplied URI.

URIs should be formatted as class:fully.qualified.class.Name. The query component of the URI, if present, will be used to retrieve the FilePosition via FilePosition#fromQuery(String). For example, line 42 and column 13 can be referenced in class org.example.MyType via the following URI: class:com.example.MyType?line=42&column=13. The URI fragment, if present, will be ignored.

Parameters
uri:URI

the URI for the class source; never null

Returns:ClassSource

a new ClassSource; never null

Annotations
@API
status:STABLE
since:1.8
Exceptions
PreconditionViolationException:
if the supplied URI is null, if the scheme of the supplied URI is not equal to the CLASS_SCHEME, or if the specified class name is empty
Since
1.8
See Also
CLASS_SCHEME
getClassNameback to summary
public String getClassName()

Get the class name of this source.

See Also
getJavaClass(), getPosition()
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.

See Also
getClassName(), getPosition()
getPositionback to summary
public Optional<FilePosition> getPosition()

Get the position in the source file for the associated class, if available.

See Also
getClassName(), getJavaClass()
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
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