Module org.junit.platform.engine

Package org.junit.platform.engine.reporting

Class FileEntry

java.lang.Object

org.junit.platform.engine.reporting.FileEntry

@API(status=MAINTAINED,
     since="1.13.3")
public final class FileEntry
extends Object

FileEntry encapsulates a file or directory to be published to the reporting infrastructure.

Since:

1.12

See Also:

• from(Path, String)

Method Summary

Modifier and Type	Method	Description
static FileEntry	from(Path path, String mediaType)	Factory for creating a new FileEntry from the supplied path and media type.
Optional<String>	getMediaType()	Get the media type of the path to be published.
Path	getPath()	Get the path for the file or directory to be published.
LocalDateTime	getTimestamp()	Get the timestamp for when this FileEntry was created.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

from

public static FileEntry from(Path path,
 String mediaType)

Factory for creating a new FileEntry from the supplied path and media type.

The Path may represent a file or a directory.

Parameters:

path - the path to publish; never null

mediaType - the media type of the path to publish; may be null — for example, if the path represents a directory

getTimestamp

public LocalDateTime getTimestamp()

Get the timestamp for when this FileEntry was created.

Returns:

when this entry was created; never null

getPath

public Path getPath()

Get the path for the file or directory to be published.

Returns:

the path to publish; never null

getMediaType

public Optional<String> getMediaType()

Get the media type of the path to be published.

Returns:

the media type of the path to publish; never null but potentially empty — for example, if the path represents a directory

toString

public String toString()

Overrides:

toString in class Object