org.savantbuild.io.tar

Class TarBuilder

java.lang.Object

org.savantbuild.io.tar.TarBuilder

public class TarBuilder
extends java.lang.Object

Helps build Tar files.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	compress
java.util.Set<Directory>	directories
java.nio.file.Path	file
java.util.List<FileSet>	fileSets
boolean	storeGroupName
boolean	storeUserName

Constructor Summary

Constructors

Constructor and Description
TarBuilder(java.nio.file.Path file)
TarBuilder(java.lang.String file)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

directories

public final java.util.Set<Directory> directories

file

public final java.nio.file.Path file

fileSets

public final java.util.List<FileSet> fileSets

compress

public boolean compress

storeGroupName

public boolean storeGroupName

storeUserName

public boolean storeUserName

Constructor Detail

TarBuilder

public TarBuilder(java.lang.String file)

TarBuilder

public TarBuilder(java.nio.file.Path file)

Method Detail

build

public int build()
          throws java.io.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:

java.io.IOException - If the build fails.

directory

public TarBuilder directory(Directory directory)
                     throws java.io.IOException

Throws:

java.io.IOException

getExplodedSize

public long getExplodedSize()
                     throws java.io.IOException

Throws:

java.io.IOException

fileSet

public TarBuilder fileSet(java.nio.file.Path directory)
                   throws java.io.IOException

Throws:

java.io.IOException

fileSet

public TarBuilder fileSet(java.lang.String directory)
                   throws java.io.IOException

Throws:

java.io.IOException

fileSet

public TarBuilder fileSet(FileSet fileSet)
                   throws java.io.IOException

Throws:

java.io.IOException

optionalFileSet

public TarBuilder optionalFileSet(java.nio.file.Path directory)
                           throws java.io.IOException

Throws:

java.io.IOException

optionalFileSet

public TarBuilder optionalFileSet(java.lang.String directory)
                           throws java.io.IOException

Throws:

java.io.IOException

optionalFileSet

public TarBuilder optionalFileSet(FileSet fileSet)
                           throws java.io.IOException

Throws:

java.io.IOException