Package de.skuzzle.test.snapshots

Class ContextFiles

java.lang.Object

de.skuzzle.test.snapshots.ContextFiles

@API(status=EXPERIMENTAL,
     since="1.8.0")
public final class ContextFiles
extends java.lang.Object

Holds the paths to all files that might have been generated by a single snapshot assertion.

Depending on the configuration (i.e. SnapshotTestOptions )

Since:

1.8.0

Method Summary

Modifier and Type	Method	Description
java.nio.file.Path	actualResultFile()	Path to the file in which the latest actual result will be stored.
void	deleteFiles()	Deletes all the context files that are existing.
static ContextFiles	of(java.nio.file.Path snapshotFile, java.nio.file.Path actualResultFile, java.nio.file.Path rawActualResultFile)
java.nio.file.Path	rawActualResultFile()	Path to the file in which the latest raw actual result will be stored (without the snapshot header).
java.nio.file.Path	snapshotFile()	The snapshot file.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static ContextFiles of(java.nio.file.Path snapshotFile,
                              java.nio.file.Path actualResultFile,
                              java.nio.file.Path rawActualResultFile)

snapshotFile

public java.nio.file.Path snapshotFile()

The snapshot file. Note that it is possible that the file does not exist in case that SnapshotTestResult.status() is SnapshotTestResult.SnapshotStatus.DISABLED.

Returns:

The snapshot file.

See Also:

actualResultFile(), rawActualResultFile()

actualResultFile

public java.nio.file.Path actualResultFile()

Path to the file in which the latest actual result will be stored. The file will only exist if the recent snapshot assertion was executed with SnapshotTestOptions.alwaysPersistActualResult() being true.

Returns:

The path to the file with the latest actual result file.

See Also:

snapshotFile(), rawActualResultFile(), SnapshotTestOptions.alwaysPersistActualResult()

rawActualResultFile

public java.nio.file.Path rawActualResultFile()

Path to the file in which the latest raw actual result will be stored (without the snapshot header). The file will only exist if the recent snapshot assertion was executed with SnapshotTestOptions.alwaysPersistRawResult() being true.

Returns:

The path to the file with the latest raw actual result file.

See Also:

snapshotFile(), actualResultFile(), SnapshotTestOptions.alwaysPersistRawResult()

deleteFiles

public void deleteFiles()

Deletes all the context files that are existing.