AbstractTestCase (Commons Compress 1.6-SNAPSHOT Test API)

java.lang.Object
- junit.framework.Assert
- - junit.framework.TestCase
  - - org.apache.commons.compress.AbstractTestCase

All Implemented Interfaces:

junit.framework.Test

Direct Known Subclasses:

ArArchiveInputStreamTest, ArArchiveOutputStreamTest, ArchiveOutputStreamTest, ArchiveReadTests, ArchiveUtilsTest, ArTestCase, BZip2TestCase, ChainingTestCase, ChangeSetTestCase, CpioArchiveInputStreamTest, CpioArchiveOutputStreamTest, CpioTestCase, DetectArchiverTestCase, DumpArchiveInputStreamTest, DumpTestCase, GZipTestCase, IOMethodsTest, JarTestCase, LongPathTest, Pack200TestCase, Pack200UtilsTest, SevenZFileTest, TarArchiveOutputStreamTest, TarTestCase, UTF8ZipFilesTest, XZTestCase, ZipTestCase
```
public abstract class AbstractTestCase
extends junit.framework.TestCase
```

Field Summary

Fields
Modifier and Type Field and Description

protected List<String> archiveList

protected File dir

protected ArchiveStreamFactory factory

protected File resultDir

Fields
Modifier and Type	Field and Description
`protected List<String>`	`archiveList`
`protected File`	`dir`
`protected ArchiveStreamFactory`	`factory`
`protected File`	`resultDir`

Constructor Summary

Constructors
Constructor and Description

AbstractTestCase()

AbstractTestCase(String name)

Constructors
Constructor and Description
`AbstractTestCase()`
`AbstractTestCase(String name)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`checkArchiveContent(ArchiveInputStream in, List<String> expected)` Checks that an archive input stream can be read, and that the file data matches file sizes.
`protected File`	`checkArchiveContent(ArchiveInputStream in, List<String> expected, boolean cleanUp)` Checks that an archive input stream can be read, and that the file data matches file sizes.
`protected void`	`checkArchiveContent(File archive, List<String> expected)` Checks if an archive contains all expected files.
`protected void`	`closeQuietly(Closeable closeable)`
`protected File`	`createArchive(String archivename)` Creates an archive of textbased files in several directories.
`protected File`	`createEmptyArchive(String archivename)` Create an empty archive.
`protected File`	`createSingleEntryArchive(String archivename)` Create an archive with a single file "test1.xml".
`protected File[]`	`createTempDirAndFile()` Creates a temporary directory and a temporary file inside that directory, returns both of them (the directory is the first element of the two element array).
`protected String`	`getExpectedString(ArchiveEntry entry)` Override this method to change what is to be compared in the List.
`static File`	`getFile(String path)`
`static File`	`mkdir(String name)`
`static void`	`rmdir(File f)`
`protected void`	`setUp()`
`protected void`	`tearDown()`
`static boolean`	`tryHardToDelete(File f)` Accommodate Windows bug encountered in both Sun and IBM JDKs.

Methods inherited from class junit.framework.TestCase
assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, countTestCases, createResult, fail, fail, failNotEquals, failNotSame, failSame, format, getName, run, run, runBare, runTest, setName, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - dir
```
protected File dir
```
  - resultDir
```
protected File resultDir
```
  - archiveList
```
protected List<String> archiveList
```
  - factory
```
protected ArchiveStreamFactory factory
```
- Constructor Detail
  - AbstractTestCase
```
public AbstractTestCase()
```
  - AbstractTestCase
```
public AbstractTestCase(String name)
```
- Method Detail
  - setUp
```
protected void setUp()
              throws Exception
```
    Overrides:
    
    setUp in class junit.framework.TestCase
    
    Throws:
    
    Exception
  - mkdir
```
public static File mkdir(String name)
                  throws IOException
```
    Throws:
    
    IOException
  - getFile
```
public static File getFile(String path)
                    throws IOException
```
    Throws:
    
    IOException
  - tearDown
```
protected void tearDown()
                 throws Exception
```
    Overrides:
    
    tearDown in class junit.framework.TestCase
    
    Throws:
    
    Exception
  - rmdir
```
public static void rmdir(File f)
```
  - tryHardToDelete
```
public static boolean tryHardToDelete(File f)
```
    Accommodate Windows bug encountered in both Sun and IBM JDKs. Others possible. If the delete does not work, call System.gc(), wait a little and try again.
    
    Returns:
    whether deletion was successful
    Since:
    
    Stolen from FileUtils in Ant 1.8.0
  - createArchive
```
protected File createArchive(String archivename)
                      throws Exception
```
    Creates an archive of textbased files in several directories. The archivername is the factory identifier for the archiver, for example zip, tar, cpio, jar, ar. The archive is created as a temp file. The archive contains the following files:
    - testdata/test1.xml
    - testdata/test2.xml
    - test/test3.xml
    - bla/test4.xml
    - bla/test5.xml
    - bla/blubber/test6.xml
    - test.txt
    - something/bla
    - test with spaces.txt
    Parameters:
    archivename - the identifier of this archive
    
    Returns:
    the newly created file
    
    Throws:
    
    Exception - in case something goes wrong
  - createEmptyArchive
```
protected File createEmptyArchive(String archivename)
                           throws Exception
```
    Create an empty archive.
    
    Parameters:
    archivename -
    
    Returns:
    the archive File
    
    Throws:
    
    Exception
  - createSingleEntryArchive
```
protected File createSingleEntryArchive(String archivename)
                                 throws Exception
```
    Create an archive with a single file "test1.xml".
    
    Parameters:
    archivename -
    
    Returns:
    the archive File
    
    Throws:
    
    Exception
  - checkArchiveContent
```
protected void checkArchiveContent(File archive,
                       List<String> expected)
                            throws Exception
```
    Checks if an archive contains all expected files.
    
    Parameters:
    archive - the archive to check
    expected - a list with expected string filenames
    
    Throws:
    
    Exception
  - checkArchiveContent
```
protected void checkArchiveContent(ArchiveInputStream in,
                       List<String> expected)
                            throws Exception
```
    Checks that an archive input stream can be read, and that the file data matches file sizes.
    
    Parameters:
    in -
    expected - list of expected entries or null if no check of names desired
    
    Throws:
    
    Exception
  - checkArchiveContent
```
protected File checkArchiveContent(ArchiveInputStream in,
                       List<String> expected,
                       boolean cleanUp)
                            throws Exception
```
    Checks that an archive input stream can be read, and that the file data matches file sizes.
    
    Parameters:
    in -
    expected - list of expected entries or null if no check of names desired
    cleanUp - Cleans up resources if true
    
    Returns:
    returns the created result file if cleanUp = false, or null otherwise
    
    Throws:
    
    Exception
  - getExpectedString
```
protected String getExpectedString(ArchiveEntry entry)
```
    Override this method to change what is to be compared in the List. For example, size + name instead of just name.
    
    Parameters:
    entry -
    
    Returns:
    returns the entry name
  - createTempDirAndFile
```
protected File[] createTempDirAndFile()
                               throws IOException
```
    Creates a temporary directory and a temporary file inside that directory, returns both of them (the directory is the first element of the two element array).
    
    Throws:
    
    IOException
  - closeQuietly
```
protected void closeQuietly(Closeable closeable)
```

Class AbstractTestCase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class junit.framework.TestCase

Methods inherited from class java.lang.Object

Field Detail

dir

resultDir

archiveList

factory

Constructor Detail

AbstractTestCase

AbstractTestCase

Method Detail

setUp

mkdir

getFile

tearDown

rmdir

tryHardToDelete

createArchive

createEmptyArchive

createSingleEntryArchive

checkArchiveContent

checkArchiveContent

checkArchiveContent

getExpectedString

createTempDirAndFile

closeQuietly