de.unkrig.commons.junit4

Class Files

java.lang.Object

de.unkrig.commons.junit4.Files

public class Files
extends java.lang.Object

A helper class for creating, reading and comparing directory trees (and contained ZIP files). Extremely useful for testing code that processes or transforms directory trees and/or ZIP files.

Constructor Summary

Constructors

Constructor and Description
Files(java.io.File file) Initializes this object from the given file or directory.
Files(java.lang.Object[] desc) Initializes this object from the given object array.

Method Summary

Modifier and Type	Method and Description
java.lang.String	diff(Files that)
static java.lang.String	diff(java.lang.String name, java.lang.Object desc1, java.lang.Object desc2)
static java.lang.Object	loadPlainFile(java.io.File file)
void	save(java.io.File file) Creates the directory tree in the file system.

Methods inherited from class java.lang.Object

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

Constructor Detail

Files

public Files(java.lang.Object[] desc)

Initializes this object from the given object array.

Files

public Files(java.io.File file)
      throws java.io.IOException,
             org.apache.commons.compress.archivers.ArchiveException,
             org.apache.commons.compress.compressors.CompressorException

Initializes this object from the given file or directory.

Throws:

java.io.IOException

org.apache.commons.compress.archivers.ArchiveException

org.apache.commons.compress.compressors.CompressorException

Method Detail

diff

@Nullable
public java.lang.String diff(Files that)

Returns:

null if this and that are equal, or a human-readable text that describes the first difference between this and that

diff

@Nullable
public static java.lang.String diff(java.lang.String name,
                                               java.lang.Object desc1,
                                               java.lang.Object desc2)

Parameters:

name - Is included in the return value

Returns:

null if desc1 and desc2 are equal, or a human-readable text that describes the first difference between desc1 and desc2

save

public void save(java.io.File file)
          throws java.io.IOException

Creates the directory tree in the file system.

Throws:

java.io.IOException

loadPlainFile

public static java.lang.Object loadPlainFile(java.io.File file)
                                      throws java.io.IOException

Returns:

The file's contents; lines separated with '\n'

Throws:

java.io.IOException