dev.gradleplugins.grava.testing.file

Class TestNameTestDirectoryProvider

java.lang.Object

dev.gradleplugins.grava.testing.file.TestNameTestDirectoryProvider

All Implemented Interfaces:

TestDirectoryProvider, java.lang.AutoCloseable

public final class TestNameTestDirectoryProvider
extends java.lang.Object

A JUnit rule which provides a unique temporary folder for the test.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.file.Path	root

Constructor Summary

Constructors

Constructor and Description
TestNameTestDirectoryProvider(java.lang.Class<?> klass)
TestNameTestDirectoryProvider(java.nio.file.Path root, java.lang.Class<?> klass)

Method Summary

Modifier and Type	Method and Description
void	cleanup()
void	close()
java.nio.file.Path	createDirectory(java.lang.Object... path)
java.nio.file.Path	createFile(java.lang.Object... path)
java.nio.file.Path	file(java.lang.Object... path)
java.nio.file.Path	getRoot()
java.nio.file.Path	getTestDirectory() The directory to use, guaranteed to exist.
protected void	init(java.lang.String methodName)
boolean	isCleanup()
static TestNameTestDirectoryProvider	newInstance(java.lang.Class<?> testClass)
static TestNameTestDirectoryProvider	newInstance(java.lang.String methodName, java.lang.Object target)
void	suppressCleanup()
void	suppressCleanupErrors()

Methods inherited from class java.lang.Object

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

Field Detail

root

protected final java.nio.file.Path root

Constructor Detail

TestNameTestDirectoryProvider

public TestNameTestDirectoryProvider(java.lang.Class<?> klass)

TestNameTestDirectoryProvider

public TestNameTestDirectoryProvider(java.nio.file.Path root,
                                     java.lang.Class<?> klass)

Method Detail

newInstance

public static TestNameTestDirectoryProvider newInstance(java.lang.Class<?> testClass)

newInstance

public static TestNameTestDirectoryProvider newInstance(java.lang.String methodName,
                                                        java.lang.Object target)

suppressCleanup

public void suppressCleanup()

Specified by:

suppressCleanup in interface TestDirectoryProvider

suppressCleanupErrors

public void suppressCleanupErrors()

Specified by:

suppressCleanupErrors in interface TestDirectoryProvider

isCleanup

public boolean isCleanup()

cleanup

public void cleanup()
             throws java.io.IOException

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

init

protected void init(java.lang.String methodName)

getTestDirectory

public java.nio.file.Path getTestDirectory()

Description copied from interface: TestDirectoryProvider

The directory to use, guaranteed to exist.

Specified by:

getTestDirectory in interface TestDirectoryProvider

Returns:

The directory to use, guaranteed to exist.

file

public java.nio.file.Path file(java.lang.Object... path)

createFile

public java.nio.file.Path createFile(java.lang.Object... path)

createDirectory

public java.nio.file.Path createDirectory(java.lang.Object... path)

getRoot

public java.nio.file.Path getRoot()