fm.last.commons.test.file

Class TemporaryFolder

java.lang.Object

fm.last.commons.test.file.TemporaryFolder

All Implemented Interfaces:

org.junit.rules.MethodRule

public class TemporaryFolder
extends Object
implements org.junit.rules.MethodRule

Why we have our own version of this class: http://stackoverflow.com/questions/7738881/junit-rule-lifecycle-interaction-with-before

The TemporaryFolder Rule allows creation of files and folders that are guaranteed to be deleted when the test method finishes (whether it passes or fails):

 public static class HasTempFolder {
   @Rule
   public TemporaryFolder folder = new TemporaryFolder();
 
   @Test
   public void testUsingTempFolder() throws IOException {
     File createdFile = folder.newFile("myfile.txt");
     File createdFolder = folder.newFolder("subfolder");
     // ...
   }
 }
 

Constructor Summary

Constructors

Constructor and Description
TemporaryFolder()

Method Summary

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runners.model.FrameworkMethod method, Object target)
void	create() For testing purposes only.
void	delete() Delete all files and folders under the temporary folder.
File	getRoot()
File	newFile(String first, String... others) Returns a new fresh file with the given name under the temporary folder.
File	newFolder(String first, String... others) Returns a new fresh folder with the given name under the temporary folder.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemporaryFolder

public TemporaryFolder()

Method Detail

apply

public final org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                                     org.junit.runners.model.FrameworkMethod method,
                                                     Object target)

Specified by:

apply in interface org.junit.rules.MethodRule

create

public void create()
            throws IOException

For testing purposes only. Do not use.

Throws:

IOException - if a file operation fails.

newFile

public File newFile(String first,
                    String... others)
             throws IOException

Returns a new fresh file with the given name under the temporary folder.

Parameters:

first - The first path element.

others - Any other path elements.

Returns:

The new file.

Throws:

IOException - if a file operation fails.

newFolder

public File newFolder(String first,
                      String... others)

Returns a new fresh folder with the given name under the temporary folder.

Parameters:

first - The first path element.

others - Any other path elements.

Returns:

The new folder.

getRoot

public File getRoot()

Returns:

the location of this temporary folder.

delete

public void delete()

Delete all files and folders under the temporary folder. Usually not called directly, since it is automatically applied by the Rule