Package org.savantbuild.io.tar

Class TarBuilder

java.lang.Object

org.savantbuild.io.tar.TarBuilder

public class TarBuilder
extends Object

Helps build Tar files.

Field Summary

Fields

Modifier and Type	Field	Description
boolean	compress
final Set<Directory>	directories
final Path	file
final List<FileSet>	fileSets
boolean	storeGroupName
boolean	storeUserName

Constructor Summary

Constructors

Constructor	Description
TarBuilder(String file)
TarBuilder(Path file)

Method Summary

Modifier and Type	Method	Description
int	build()	Builds the TAR file using the fileSets and Directories provided.
TarBuilder	directory(Directory directory)
TarBuilder	fileSet(String directory)
TarBuilder	fileSet(Path directory)
TarBuilder	fileSet(FileSet fileSet)
long	getExplodedSize()
TarBuilder	optionalFileSet(String directory)
TarBuilder	optionalFileSet(Path directory)
TarBuilder	optionalFileSet(FileSet fileSet)

Methods inherited from class java.lang.Object

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

Field Details

directories

public final Set<Directory> directories

file

public final Path file

fileSets

public final List<FileSet> fileSets

compress

public boolean compress

storeGroupName

public boolean storeGroupName

storeUserName

public boolean storeUserName

Constructor Details

TarBuilder

public TarBuilder(String file)

TarBuilder

public TarBuilder(Path file)

Method Details

build

public int build()
          throws IOException

Builds the TAR file using the fileSets and Directories provided.

Returns:

The number of entries added to the TAR file including the directories.

Throws:

IOException - If the build fails.

directory

public TarBuilder directory(Directory directory)
                     throws IOException

Throws:

IOException

getExplodedSize

public long getExplodedSize()
                     throws IOException

Throws:

IOException

fileSet

public TarBuilder fileSet(Path directory)
                   throws IOException

Throws:

IOException

fileSet

public TarBuilder fileSet(String directory)
                   throws IOException

Throws:

IOException

fileSet

public TarBuilder fileSet(FileSet fileSet)
                   throws IOException

Throws:

IOException

optionalFileSet

public TarBuilder optionalFileSet(Path directory)
                           throws IOException

Throws:

IOException

optionalFileSet

public TarBuilder optionalFileSet(String directory)
                           throws IOException

Throws:

IOException

optionalFileSet

public TarBuilder optionalFileSet(FileSet fileSet)
                           throws IOException

Throws:

IOException