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

Modifier and Type	Field and Description
private final File	file
private final @Nullable FilePosition	filePosition
private static final long	serialVersionUID

Access	Constructor and Description
private	FileSource(File file)
private	FileSource(File file, @Nullable FilePosition filePosition)
private	FileSource(FileSource fileSource, @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 FileSource	from(File the source file; must not be `null` file) Create a new `FileSource` using the supplied `file`.
public static FileSource	from(File the source file; must not be `null` file, @Nullable FilePosition the position in the source file; may be `null` filePosition) Create a new `FileSource` using the supplied `file` and `filePosition`.
public File	Returns: the source file; never `null` getFile() Implements org.junit.platform.engine.support.descriptor.FileSystemSource.getFile. Get the source file.
public Optional<FilePosition>	getPosition() Get the `FilePosition`, if available.
public URI	Returns: the source `URI`; never `null` getUri() Implements org.junit.platform.engine.support.descriptor.UriSource.getUri. Get the `URI` for the source file.
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.
public FileSource	Returns: a `FileSource` based on this instance but with the supplied `FilePosition` withPosition(@Nullable FilePosition the position in the source file; may be `null` filePosition) Returns a `FileSource` based on this instance but with the supplied `FilePosition`.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

file	back to summary
private final File file

filePosition	back to summary
private final @Nullable FilePosition filePosition

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

FileSource	back to summary
private FileSource(File file)

FileSource	back to summary
private FileSource(File file, @Nullable FilePosition filePosition)

FileSource	back to summary
private FileSource(FileSource fileSource, @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 FileSource from(File file) Create a new `FileSource` using the supplied `file`. Parameters file:File the source file; must not be `null`

public static FileSource from(File file)

Create a new FileSource using the supplied file.

Parameters

file:File: the source file; must not be null

from back to summary

from	back to summary
public static FileSource from(File file, @Nullable FilePosition filePosition) Create a new `FileSource` using the supplied `file` and `filePosition`. Parameters file:File the source file; must not be `null` filePosition:@Nullable FilePosition the position in the source file; may be `null` See Also `withPosition(FilePosition)`

public static FileSource from(File file, @Nullable FilePosition filePosition)

Create a new FileSource using the supplied file and filePosition.

Parameters

file:File: the source file; must not be null
filePosition:@Nullable FilePosition: the position in the source file; may be null

See Also

withPosition(FilePosition)

getFile back to summary

getFile	back to summary
public File getFile() Implements org.junit.platform.engine.support.descriptor.FileSystemSource.getFile. Get the source file. Returns:File the source file; never `null` Annotations @Override

public File getFile()

Implements org.junit.platform.engine.support.descriptor.FileSystemSource.getFile.

Get the source file.

Returns:File

the source file; never null

Annotations

@Override

getPosition	back to summary
public Optional<FilePosition> getPosition() Get the `FilePosition`, if available.

getUri back to summary

getUri	back to summary
public URI getUri() Implements org.junit.platform.engine.support.descriptor.UriSource.getUri. Get the `URI` for the source file. Returns:URI the source `URI`; never `null` Annotations @Override

public URI getUri()

Implements org.junit.platform.engine.support.descriptor.UriSource.getUri.

Get the URI for the source file.

Returns:URI

the source URI; never null

Annotations

@Override

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

withPosition back to summary

withPosition	back to summary
public FileSource withPosition(@Nullable FilePosition filePosition) Returns a `FileSource` based on this instance but with the supplied `FilePosition`. If the supplied `FilePosition` equals the existing one, this method returns `this`. Otherwise, a new instance is created and returned. Calling this method rather than creating a new `FileSource` via `from(File, FilePosition)` avoids the overhead of redundant canonical path resolution. Parameters filePosition:@Nullable FilePosition the position in the source file; may be `null` Returns:FileSource a `FileSource` based on this instance but with the supplied `FilePosition` Annotations @API status:EXPERIMENTAL since:1.14 Since 1.14

public FileSource withPosition(@Nullable FilePosition filePosition)

Returns a FileSource based on this instance but with the supplied FilePosition.

If the supplied FilePosition equals the existing one, this method returns this. Otherwise, a new instance is created and returned.

Calling this method rather than creating a new FileSource via from(File, FilePosition) avoids the overhead of redundant canonical path resolution.

Parameters

filePosition:@Nullable FilePosition: the position in the source file; may be null

Returns:FileSource

a FileSource based on this instance but with the supplied FilePosition

Annotations

@API
status:EXPERIMENTAL
since:1.14

Since

1.14

public final Class FileSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail