UnTar (Aozan 3.1 API)

java.lang.Object
- fr.ens.biologie.genomique.aozan.aozan3.util.UnTar

```
public class UnTar
extends Object
```
This class allow to create untar archives.

Since:

3.0

Author:

Laurent Jourdren

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class UnTar.Compression

Constructor Summary

Constructors
Constructor Description

UnTar(Path inputArchive, Path outputDirectoryPath)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`execute()`	Execute untar.
`UnTar.Compression`	`getCompression()`	Get tar compression.
`void`	`setCompression(UnTar.Compression compression)`	Set the tar compression

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

- Constructor Detail
  - UnTar
```
public UnTar(Path inputArchive,
             Path outputDirectoryPath)
      throws Aozan3Exception
```
    Constructor.
    
    Parameters:
    
    inputArchive - input tar file
    
    outputDirectoryPath - output directory for tar file content
    
    Throws:
    
    Aozan3Exception - if input archive or output directory path are not found or not readable/writable
- Method Detail
  - getCompression
```
public UnTar.Compression getCompression()
```
    Get tar compression.
    
    Returns:
    
    the tar compression
  - setCompression
```
public void setCompression(UnTar.Compression compression)
```
    Set the tar compression
    
    Parameters:
    
    compression - the tar compression
  - execute
```
public void execute()
             throws Aozan3Exception
```
    Execute untar.
    
    Throws:
    
    Aozan3Exception - if an error occurs while untarring data