cz.auderis.test.rule

Class WorkFolder

java.lang.Object

org.junit.rules.ExternalResource

org.junit.rules.TemporaryFolder

cz.auderis.test.rule.WorkFolder

All Implemented Interfaces:

WorkFolderInterface, org.junit.rules.TestRule

public class WorkFolder
extends org.junit.rules.TemporaryFolder
implements WorkFolderInterface

Extension of TemporaryFolder that has better support for initial content preparation.

Initialization examples:

      @Rule public WorkFolder work1 = WorkFolder.basic();
      @Rule public WorkFolder work2 = WorkFolder.subfolderOf(new File("/tmp/junit");
      @Rule public WorkFolder work3 = WorkFolder.basic().withResourceSearchBase(SomeClass.class);
 

Usage examples:

     File res = work1.newResourceCopy("testResource");
     File resWithPath = work1.newResourceCopy("target/dir/copy.bin", "testResource.bin");
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WorkFolder()
protected	WorkFolder(java.io.File parentFolder)

Method Summary

Modifier and Type	Method and Description
java.lang.String	absolutePath()
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
java.io.File	asFile()
static WorkFolder	basic() Creates a new instance of WorkFolder.
void	clean()
java.lang.ClassLoader	getClassLoaderForResources()
java.lang.ClassLoader	getClassLoaderForResources(java.lang.ClassLoader parentClassLoader)
WorkFolderInterface	getRootFolder()
void	installContextClassLoaderForResources(java.lang.ClassLoader parentClassLoader)
java.io.File	newFile()
java.io.File	newFile(java.lang.String targetPath, java.lang.CharSequence initialContents)
java.io.File	newFile(java.lang.String targetPath, InitialContentsProvider contentsProvider)
java.io.File	newFile(java.lang.String targetPath, java.io.InputStream initialContents)
java.io.File	newResourceCopy(java.lang.String resourceName)
java.io.File	newResourceCopy(java.lang.String targetPath, java.lang.String resourceName)
java.lang.String	relativePath()
WorkFolderInterface	subfolder(java.lang.String... pathComponents)
static WorkFolder	subfolderOf(java.io.File parentFolder)
static WorkFolder	subfolderOf(java.lang.String parentFolderPath)
WorkFolder	withResourceSearchBase(java.lang.Class<?> searchBase)

Methods inherited from class org.junit.rules.TemporaryFolder

after, before, create, delete, getRoot, newFile, newFolder, newFolder, newFolder

Methods inherited from class java.lang.Object

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

Methods inherited from interface cz.auderis.test.rule.WorkFolderInterface

newFile

Constructor Detail

WorkFolder

protected WorkFolder()

WorkFolder

protected WorkFolder(java.io.File parentFolder)

Method Detail

basic

public static WorkFolder basic()

Creates a new instance of WorkFolder.

Returns:

subfolderOf

public static WorkFolder subfolderOf(java.io.File parentFolder)

subfolderOf

public static WorkFolder subfolderOf(java.lang.String parentFolderPath)

withResourceSearchBase

public WorkFolder withResourceSearchBase(java.lang.Class<?> searchBase)

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runner.Description description)

Specified by:

apply in interface org.junit.rules.TestRule

Overrides:

apply in class org.junit.rules.ExternalResource

asFile

public java.io.File asFile()

Specified by:

asFile in interface WorkFolderInterface

absolutePath

public java.lang.String absolutePath()

Specified by:

absolutePath in interface WorkFolderInterface

relativePath

public java.lang.String relativePath()

Specified by:

relativePath in interface WorkFolderInterface

getRootFolder

public WorkFolderInterface getRootFolder()

Specified by:

getRootFolder in interface WorkFolderInterface

newFile

public java.io.File newFile()
                     throws java.io.IOException

Overrides:

newFile in class org.junit.rules.TemporaryFolder

Throws:

java.io.IOException

newFile

public java.io.File newFile(java.lang.String targetPath,
                            java.lang.CharSequence initialContents)
                     throws java.io.IOException

Specified by:

newFile in interface WorkFolderInterface

Throws:

java.io.IOException

newFile

public java.io.File newFile(java.lang.String targetPath,
                            java.io.InputStream initialContents)
                     throws java.io.IOException

Specified by:

newFile in interface WorkFolderInterface

Throws:

java.io.IOException

newFile

public java.io.File newFile(java.lang.String targetPath,
                            InitialContentsProvider contentsProvider)
                     throws java.io.IOException

Specified by:

newFile in interface WorkFolderInterface

Throws:

java.io.IOException

newResourceCopy

public java.io.File newResourceCopy(java.lang.String targetPath,
                                    java.lang.String resourceName)
                             throws java.io.IOException

Specified by:

newResourceCopy in interface WorkFolderInterface

Throws:

java.io.IOException

newResourceCopy

public java.io.File newResourceCopy(java.lang.String resourceName)
                             throws java.io.IOException

Specified by:

newResourceCopy in interface WorkFolderInterface

Throws:

java.io.IOException

subfolder

public WorkFolderInterface subfolder(java.lang.String... pathComponents)
                              throws java.io.IOException

Specified by:

subfolder in interface WorkFolderInterface

Throws:

java.io.IOException

clean

public void clean()
           throws java.io.IOException

Specified by:

clean in interface WorkFolderInterface

Throws:

java.io.IOException

getClassLoaderForResources

public java.lang.ClassLoader getClassLoaderForResources()

getClassLoaderForResources

public java.lang.ClassLoader getClassLoaderForResources(java.lang.ClassLoader parentClassLoader)

installContextClassLoaderForResources

public void installContextClassLoaderForResources(java.lang.ClassLoader parentClassLoader)