Class ClasspathResourceSource

java.lang.Object

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

All Implemented Interfaces:

Serializable, TestSource

@API(status=STABLE,
     since="1.0")
public final class ClasspathResourceSource
extends 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	Description
static final String	CLASSPATH_SCHEME	URI scheme for classpath resources: "classpath"

Method Summary

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

Methods inherited from class Object

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

Field Details

CLASSPATH_SCHEME

public static final String CLASSPATH_SCHEME

URI scheme for classpath resources: "classpath"

Since:

1.3

See Also:

• Constant Field Values

Method Details

from

public static ClasspathResourceSource from(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(String classpathResourceName,
 @Nullable 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

from

@API(status=STABLE,
     since="1.3")
public static ClasspathResourceSource from(URI uri)

Create a new ClasspathResourceSource from the supplied URI.

The path component of the URI (excluding the query) will be used as the classpath resource name. The query component of the URI, if present, will be used to retrieve the FilePosition via FilePosition.fromQuery(String).

Parameters:

uri - the URI for the classpath resource; never null

Returns:

a new ClasspathResourceSource; never null

Throws:

org.junit.platform.commons.PreconditionViolationException - if the supplied URI is null or if the scheme of the supplied URI is not equal to the CLASSPATH_SCHEME

Since:

1.3

See Also:

• CLASSPATH_SCHEME

getClasspathResourceName

public 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 Optional<FilePosition> getPosition()

Get the FilePosition, if available.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object