Module org.junit.platform.engine

Package org.junit.platform.engine.discovery

Class FileSelector

java.lang.Object

org.junit.platform.engine.discovery.FileSelector

All Implemented Interfaces:

DiscoverySelector

@API(status=STABLE,
     since="1.0")
public class FileSelector
extends Object
implements DiscoverySelector

A DiscoverySelector that selects a file so that TestEngines can discover tests or containers based on files in the file system.

Since:

1.0

See Also:

• DiscoverySelectors.selectFile(String)
• DiscoverySelectors.selectFile(File)
• DirectorySelector
• getFile()
• getPath()
• getRawPath()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileSelector.IdentifierParser	The DiscoverySelectorIdentifierParser for FileSelectors.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
File	getFile()	Get the selected file as a File.
Path	getPath()	Get the selected file as a Path using the default FileSystem.
Optional<FilePosition>	getPosition()	Get the selected position within the file as a FilePosition.
String	getRawPath()	Get the selected file as a raw path.
int	hashCode()
Optional<DiscoverySelectorIdentifier>	toIdentifier()	Return the identifier of this selector.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getFile

public File getFile()

Get the selected file as a File.

See Also:

• getPath()
• getRawPath()

getPath

public Path getPath()

Get the selected file as a Path using the default FileSystem.

See Also:

• getFile()
• getRawPath()

getRawPath

public String getRawPath()

Get the selected file as a raw path.

See Also:

• getFile()
• getPath()

getPosition

public Optional<FilePosition> getPosition()

Get the selected position within the file as a FilePosition.

equals

@API(status=STABLE,
     since="1.3")
public boolean equals(Object o)

Overrides:

equals in class Object

Since:

1.3

hashCode

@API(status=STABLE,
     since="1.3")
public int hashCode()

Overrides:

hashCode in class Object

Since:

1.3

toString

public String toString()

Overrides:

toString in class Object

toIdentifier

public Optional<DiscoverySelectorIdentifier> toIdentifier()

Description copied from interface: DiscoverySelector

Return the identifier of this selector.

The returned identifier must be parsable by a corresponding DiscoverySelectorIdentifierParser.

The default implementation returns Optional.empty(). Can be overridden by concrete implementations.

Specified by:

toIdentifier in interface DiscoverySelector

Returns:

an Optional containing the identifier of this selector; never null but potentially empty if the selector does not support identifiers