io.github.glytching.junit.extension.folder

Class TemporaryFolder

java.lang.Object

io.github.glytching.junit.extension.folder.TemporaryFolder

All Implemented Interfaces:

org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource

public class TemporaryFolder
extends Object
implements org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource

Encapsulates the rootFolder within which any files or directories will be created along with the operations which a tester may wish to invoke (createFile(String), createDirectory(String)) and post test invocations which the associated extension will invoke.

Method Summary

Modifier and Type	Method and Description
void	close()
File	createDirectory(String directoryName) Create a directory within the temporary folder root.
File	createFile(String fileName) Create a file within the temporary folder root.
File	getRoot() Returns the root folder.

Methods inherited from class java.lang.Object

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

Method Detail

close

public void close()
           throws Throwable

Specified by:

close in interface org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource

Throws:

Throwable

getRoot

public File getRoot()

Returns the root folder. Exposing this offers some back compatability with JUnit4's TemporaryFolder so test cases which are used to invoking getRoot() on a JUnit4 rule can adopt the same approach with this TemporaryFolder. In addition, this may be useful where you want to use the root folder itself without creating files or directories within it.

Note: the extension is responsible for creating/managing/destroying the root folder so don't bother trying to clean it up yourself and don't expect that anything you do to it will survive post-test-cleanup.

Returns:

the root folder

See Also:

Issue 8

createFile

public File createFile(String fileName)
                throws IOException

Create a file within the temporary folder root.

Parameters:

fileName - the name of the file to be created

Returns:

the newly created file instance

Throws:

IOException - in case the file creation call fails

createDirectory

public File createDirectory(String directoryName)

Create a directory within the temporary folder root.

Parameters:

directoryName - the name of the directory to be created

Returns:

the directory instance