Package org.junit.platform.engine.support.descriptor

Class FileSource

java.lang.Object

org.junit.platform.engine.support.descriptor.FileSource

All Implemented Interfaces:

java.io.Serializable, FileSystemSource, UriSource, TestSource

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

File based TestSource with an optional position.

Since:

1.0

See Also:

FileSelector, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private java.io.File	file
private FilePosition	filePosition
private static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FileSource(java.io.File file)
private	FileSource(java.io.File file, FilePosition filePosition)
private	FileSource(FileSource fileSource, FilePosition filePosition)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
static FileSource	from(java.io.File file)	Create a new FileSource using the supplied file.
static FileSource	from(java.io.File file, FilePosition filePosition)	Create a new FileSource using the supplied file and filePosition.
java.io.File	getFile()	Get the source file.
java.util.Optional<FilePosition>	getPosition()	Get the FilePosition, if available.
java.net.URI	getUri()	Get the URI for the source file.
int	hashCode()
java.lang.String	toString()
FileSource	withPosition(FilePosition filePosition)	{@return a {@code FileSource} based on this instance but with the supplied {@link FilePosition}}

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

file

private final java.io.File file

filePosition

private final FilePosition filePosition

Constructor Detail

FileSource

private FileSource(java.io.File file)

FileSource

private FileSource(java.io.File file,
                   FilePosition filePosition)

FileSource

private FileSource(FileSource fileSource,
                   FilePosition filePosition)

Method Detail

from

public static FileSource from(java.io.File file)

Create a new FileSource using the supplied file.

Parameters:

file - the source file; must not be null

from

public static FileSource from(java.io.File file,
                              FilePosition filePosition)

Create a new FileSource using the supplied file and filePosition.

Parameters:

file - the source file; must not be null

filePosition - the position in the source file; may be null

See Also:

withPosition(FilePosition)

getUri

public final java.net.URI getUri()

Get the URI for the source file.

Specified by:

getUri in interface UriSource

Returns:

the source URI; never null

getFile

public final java.io.File getFile()

Get the source file.

Specified by:

getFile in interface FileSystemSource

Returns:

the source file; never null

getPosition

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

Get the FilePosition, if available.

withPosition

@API(status=EXPERIMENTAL,
     since="1.14")
public FileSource withPosition(FilePosition filePosition)

{@return a {@code FileSource} based on this instance but with the supplied {@link 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 - the position in the source file; may be null

Since:

1.14

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