br.com.objectos.testing.fs

Class TestingFs

java.lang.Object

br.com.objectos.testing.fs.TestingFs

public final class TestingFs
extends Object

Provides static methods for working with directories in testing environments.

Since:

2

Method Summary

Modifier and Type	Method and Description
static Directory	createTempDirectory() Creates a randomly named directory that is automatically removed during the JVM shutdown process.
static Directory	getTestInf() Returns the parent directory of the resource named TEST-INF/.marker.
static br.com.objectos.collections.list.ImmutableList<String>	list(Directory directory) Recursively lists the relative pathnames of all entries of the specified directory; the result is both sorted and immutable.
static br.com.objectos.collections.list.ImmutableList<String>	listFiles(Directory directory) Recursively lists the relative pathnames of all (regular) files of the specified directory; the result is both sorted and immutable.

Methods inherited from class java.lang.Object

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

Method Detail

createTempDirectory

public static Directory createTempDirectory()
                                     throws IOException

Creates a randomly named directory that is automatically removed during the JVM shutdown process.

The returned directory will be a direct child of the directory returned by the JavaIoTmpdir class.

Returns:

a randomly named temporary directory

Throws:

IOException - if an I/O error occurs

getTestInf

public static Directory getTestInf()
                            throws IOException

Returns the parent directory of the resource named TEST-INF/.marker.

This is intended to ease working with test resources (as defined by Maven build tool) in modular project.

Returns:

the parent directory of the resource named TEST-INF/.marker

Throws:

IOException - if the marker cannot be found, the marker is not a regular file or another I/O error occurs

list

public static br.com.objectos.collections.list.ImmutableList<String> list(Directory directory)
                                                                   throws IOException

Recursively lists the relative pathnames of all entries of the specified directory; the result is both sorted and immutable.

Parameters:

directory - the directory to list

Returns:

sorted immutable list of all entries

Throws:

IOException - if an I/O error occurs

listFiles

public static br.com.objectos.collections.list.ImmutableList<String> listFiles(Directory directory)
                                                                        throws IOException

Recursively lists the relative pathnames of all (regular) files of the specified directory; the result is both sorted and immutable.

Parameters:

directory - the directory to list

Returns:

sorted immutable list of all files

Throws:

IOException - if an I/O error occurs