Package fr.ens.biologie.genomique.aozan.aozan3.util

Class Tar

java.lang.Object

fr.ens.biologie.genomique.aozan.aozan3.util.Tar

public class Tar
extends Object

This class allow to create tar files.

Since:

3.0

Author:

Laurent Jourdren

Constructor Summary

Constructors

Constructor	Description
Tar(Path inputDirectoryPath, Path outputArchive)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addExcludePattern(String pattern)	Add a pattern to exclude.
void	addIncludePattern(String pattern)	Add a pattern to exclude.
void	execute()	Execute tar.
UnTar.Compression	getCompression()	Get tar compression.
List<String>	getExcludePatterns()	Get the list of patterns to exclude.
List<String>	getIncludePatterns()	Get the list of patterns to include.
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

Tar

public Tar(Path inputDirectoryPath,
           Path outputArchive)
    throws Aozan3Exception

Constructor.

Parameters:

inputDirectoryPath - input tar file

outputArchive - 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

addExcludePattern

public void addExcludePattern(String pattern)

Add a pattern to exclude.

Parameters:

pattern - pattern to exclude

getExcludePatterns

public List<String> getExcludePatterns()

Get the list of patterns to exclude.

Returns:

the list of patterns to exclude

addIncludePattern

public void addIncludePattern(String pattern)

Add a pattern to exclude.

Parameters:

pattern - pattern to exclude

getIncludePatterns

public List<String> getIncludePatterns()

Get the list of patterns to include.

Returns:

the list of patterns to include

execute

public void execute()
             throws Aozan3Exception

Execute tar.

Throws:

Aozan3Exception - if an error occurs while untarring data