JUnit 6.0.1 · org.junit.platform.engine.support.descriptor.ClasspathResourceSource

Modifier and Type	Field and Description
public static final String	CLASSPATH_SCHEME `URI` scheme for classpath resources:
private final String	classpathResourceName
private final @Nullable FilePosition	filePosition
private static final long	serialVersionUID

Access	Constructor and Description
private	ClasspathResourceSource(String classpathResourceName)
private	ClasspathResourceSource(String classpathResourceName, @Nullable FilePosition filePosition)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static ClasspathResourceSource	from(String the name of the classpath resource; never `null` or blank classpathResourceName) Create a new `ClasspathResourceSource` using the supplied classpath resource name.
public static ClasspathResourceSource	from(String the name of the classpath resource; never `null` or blank classpathResourceName, @Nullable FilePosition the position in the classpath resource; may be `null` filePosition) Create a new `ClasspathResourceSource` using the supplied classpath resource name and `FilePosition`.
public static ClasspathResourceSource	Returns: a new `ClasspathResourceSource`; never `null` from(URI the `URI` for the classpath resource; never `null` uri) Create a new `ClasspathResourceSource` from the supplied `URI`.
public String	getClasspathResourceName() Get the name of the source classpath resource.
public Optional<FilePosition>	getPosition() Get the `FilePosition`, 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:: clone finalize getClass notify notifyAll wait wait wait

CLASSPATH_SCHEME	back to summary
public static final String CLASSPATH_SCHEME `URI` scheme for classpath resources: Since 1.3

classpathResourceName	back to summary
private final String classpathResourceName

filePosition	back to summary
private final @Nullable FilePosition filePosition

serialVersionUID	back to summary
private static final long serialVersionUID Annotations @Serial

ClasspathResourceSource	back to summary
private ClasspathResourceSource(String classpathResourceName)

ClasspathResourceSource	back to summary
private ClasspathResourceSource(String classpathResourceName, @Nullable FilePosition filePosition)

Method Detail

equals back to summary

equals	back 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

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

from back to summary

from	back to summary
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:String the name of the classpath resource; never `null` or blank See Also `ClassLoader#getResource(String)`, `ClassLoader#getResourceAsStream(String)`, `ClassLoader#getResources(String)`

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:String: the name of the classpath resource; never null or blank

from back to summary

from	back to summary
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:String the name of the classpath resource; never `null` or blank filePosition:@Nullable FilePosition the position in the classpath resource; may be `null`

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:String: the name of the classpath resource; never null or blank
filePosition:@Nullable FilePosition: the position in the classpath resource; may be null

from back to summary

from	back to summary
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:URI the `URI` for the classpath resource; never `null` Returns:ClasspathResourceSource a new `ClasspathResourceSource`; never `null` Annotations @API status:STABLE since:1.3 Exceptions 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`

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:URI: the URI for the classpath resource; never null

Returns:ClasspathResourceSource

a new ClasspathResourceSource; never null

Annotations

@API
status:STABLE
since:1.3

Exceptions

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 back to summary

getClasspathResourceName	back to summary
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)`

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	back to summary
public Optional<FilePosition> getPosition() Get the `FilePosition`, if available.

hashCode back to summary

hashCode	back 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

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

toString back to summary

toString	back 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

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

public final Class ClasspathResourceSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail