org.junit.platform.engine.support.descriptor

Class ClasspathResourceSource

java.lang.Object

org.junit.platform.engine.support.descriptor.ClasspathResourceSource

All Implemented Interfaces:

java.io.Serializable, TestSource

@API(status=STABLE,
     since="1.0")
public class ClasspathResourceSource
extends java.lang.Object
implements TestSource

Classpath resource based TestSource with an optional position.

Since:

1.0

See Also:

ClasspathResourceSelector, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	classpathResourceName
private FilePosition	filePosition
private static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ClasspathResourceSource(java.lang.String classpathResourceName)
private	ClasspathResourceSource(java.lang.String classpathResourceName, FilePosition filePosition)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static ClasspathResourceSource	from(java.lang.String classpathResourceName) Create a new ClasspathResourceSource using the supplied classpath resource name.
static ClasspathResourceSource	from(java.lang.String classpathResourceName, FilePosition filePosition) Create a new ClasspathResourceSource using the supplied classpath resource name and FilePosition.
java.lang.String	getClasspathResourceName() Get the name of the source classpath resource.
java.util.Optional<FilePosition>	getPosition() Get the FilePosition, if available.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

classpathResourceName

private final java.lang.String classpathResourceName

filePosition

private final FilePosition filePosition

Constructor Detail

ClasspathResourceSource

private ClasspathResourceSource(java.lang.String classpathResourceName)

ClasspathResourceSource

private ClasspathResourceSource(java.lang.String classpathResourceName,
                                FilePosition filePosition)

Method Detail

from

public static ClasspathResourceSource from(java.lang.String classpathResourceName)

Create a new ClasspathResourceSource using the supplied classpath resource name.

The name of a classpath resource must follow the semantics for resource paths as defined in ClassLoader.getResource(String).

If the supplied classpath resource name is prefixed with a slash (/), the slash will be removed.

Parameters:

classpathResourceName - the name of the classpath resource; never null or blank

See Also:

ClassLoader.getResource(String), ClassLoader.getResourceAsStream(String), ClassLoader.getResources(String)

from

public static ClasspathResourceSource from(java.lang.String classpathResourceName,
                                           FilePosition filePosition)

Create a new ClasspathResourceSource using the supplied classpath resource name and FilePosition.

The name of a classpath resource must follow the semantics for resource paths as defined in ClassLoader.getResource(String).

If the supplied classpath resource name is prefixed with a slash (/), the slash will be removed.

Parameters:

classpathResourceName - the name of the classpath resource; never null or blank

filePosition - the position in the classpath resource; may be null

getClasspathResourceName

public java.lang.String getClasspathResourceName()

Get the name of the source classpath resource.

The name of a classpath resource follows the semantics for resource paths as defined in ClassLoader.getResource(String).

See Also:

ClassLoader.getResource(String), ClassLoader.getResourceAsStream(String), ClassLoader.getResources(String)

getPosition

public final java.util.Optional<FilePosition> getPosition()

Get the FilePosition, if available.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object