Package org.junit.rules

Class TemporaryFolder

  • All Implemented Interfaces:
    TestRule
    public class TemporaryFolder
extends ExternalResource
    The TemporaryFolder Rule allows creation of files and folders that should be deleted when the test method finishes (whether it passes or fails). By default no exception will be thrown in case the deletion fails.

    Example of usage: 

     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");
      // ...
     }
 }

    TemporaryFolder rule supports assured deletion mode, which will fail the test in case deletion fails with AssertionError.

    Creating TemporaryFolder with assured deletion: 

      @Rule
  public TemporaryFolder folder= TemporaryFolder.builder().assureDeletion().build();
    Since:
    4.7

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        TemporaryFolder()
      Create a temporary folder which uses system default temporary-file directory to create temporary resources.
        TemporaryFolder​(java.io.File parentFolder)
      Create a temporary folder which uses the specified directory to create temporary resources.
      protected TemporaryFolder​(TemporaryFolder.Builder builder)
      Create a TemporaryFolder initialized with values from a builder.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void after()
      Override to tear down your specific external resource.
      protected void before()
      Override to set up your specific external resource.
      static TemporaryFolder.Builder builder()
      Returns a new builder for building an instance of TemporaryFolder.
      void create()
      for testing purposes only.
      private static java.io.File createTemporaryFolderIn​(java.io.File parentFolder)  
      private static java.io.File createTemporaryFolderWithFileApi​(java.io.File parentFolder)  
      private static java.io.File createTemporaryFolderWithNioApi​(java.io.File parentFolder)  
      void delete()
      Delete all files and folders under the temporary folder.
      java.io.File getRoot()  
      java.io.File newFile()
      Returns a new fresh file with a random name under the temporary folder.
      java.io.File newFile​(java.lang.String fileName)
      Returns a new fresh file with the given name under the temporary folder.
      java.io.File newFolder()
      Returns a new fresh folder with a random name under the temporary folder.
      java.io.File newFolder​(java.lang.String path)
      Returns a new fresh folder with the given path under the temporary folder.
      java.io.File newFolder​(java.lang.String... paths)
      Returns a new fresh folder with the given paths under the temporary folder.
      private boolean recursiveDelete​(java.io.File file)  
      private boolean tryDelete()
      Tries to delete all files and folders under the temporary folder and returns whether deletion was successful or not.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • parentFolder

        private final java.io.File parentFolder

      • assureDeletion

        private final boolean assureDeletion

      • folder

        private java.io.File folder

    • Constructor Detail

      • TemporaryFolder

        public TemporaryFolder()
        Create a temporary folder which uses system default temporary-file directory to create temporary resources.

      • TemporaryFolder

        public TemporaryFolder​(java.io.File parentFolder)
        Create a temporary folder which uses the specified directory to create temporary resources.
        Parameters:
        parentFolder - folder where temporary resources will be created. If null then system default temporary-file directory is used.

    • Method Detail

      • before

        protected void before()
               throws java.lang.Throwable
        Description copied from class: ExternalResource
        Override to set up your specific external resource.
        Overrides:
        before in class ExternalResource
        Throws:
        java.lang.Throwable - if setup fails (which will disable after

      • create

        public void create()
            throws java.io.IOException
        for testing purposes only. Do not use.
        Throws:
        java.io.IOException

      • newFile

        public java.io.File newFile​(java.lang.String fileName)
                     throws java.io.IOException
        Returns a new fresh file with the given name under the temporary folder.
        Throws:
        java.io.IOException

      • newFile

        public java.io.File newFile()
                     throws java.io.IOException
        Returns a new fresh file with a random name under the temporary folder.
        Throws:
        java.io.IOException

      • newFolder

        public java.io.File newFolder​(java.lang.String path)
                       throws java.io.IOException
        Returns a new fresh folder with the given path under the temporary folder.
        Throws:
        java.io.IOException

      • newFolder

        public java.io.File newFolder​(java.lang.String... paths)
                       throws java.io.IOException
        Returns a new fresh folder with the given paths under the temporary folder. For example, if you pass in the strings "parent" and "child" then a directory named "parent" will be created under the temporary folder and a directory named "child" will be created under the newly-created "parent" directory.
        Throws:
        java.io.IOException

      • newFolder

        public java.io.File newFolder()
                       throws java.io.IOException
        Returns a new fresh folder with a random name under the temporary folder.
        Throws:
        java.io.IOException

      • createTemporaryFolderIn

        private static java.io.File createTemporaryFolderIn​(java.io.File parentFolder)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • createTemporaryFolderWithNioApi

        private static java.io.File createTemporaryFolderWithNioApi​(java.io.File parentFolder)
                                                     throws java.lang.ClassNotFoundException,
                                                            java.lang.NoSuchMethodException,
                                                            java.lang.reflect.InvocationTargetException,
                                                            java.lang.IllegalAccessException
        Throws:
        java.lang.ClassNotFoundException
        java.lang.NoSuchMethodException
        java.lang.reflect.InvocationTargetException
        java.lang.IllegalAccessException

      • createTemporaryFolderWithFileApi

        private static java.io.File createTemporaryFolderWithFileApi​(java.io.File parentFolder)
                                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • getRoot

        public java.io.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.
        Throws:
        java.lang.AssertionError - if unable to clean up resources and deletion of resources is assured.

      • tryDelete

        private boolean tryDelete()
        Tries to delete all files and folders under the temporary folder and returns whether deletion was successful or not.
        Returns:
        true if all resources are deleted successfully, false otherwise.

      • recursiveDelete

        private boolean recursiveDelete​(java.io.File file)