com.microsoft.jenkins.acr.common.compression

Class CompressibleFileImpl

java.lang.Object

java.io.OutputStream

org.apache.commons.compress.archivers.ArchiveOutputStream

org.apache.commons.compress.archivers.tar.TarArchiveOutputStream

com.microsoft.jenkins.acr.common.compression.CompressibleFileImpl

All Implemented Interfaces:

Compression.CompressedFile, Compression.CompressibleFile, Compression.CompressibleWithFile, Compression.CompressibleWithIgnore, Closeable, Flushable, AutoCloseable

public class CompressibleFileImpl
extends org.apache.commons.compress.archivers.tar.TarArchiveOutputStream
implements Compression.CompressedFile, Compression.CompressibleFile, Compression.CompressibleWithFile, Compression.CompressibleWithIgnore

Create a compressed file.

Field Summary

Fields inherited from class org.apache.commons.compress.archivers.tar.TarArchiveOutputStream

BIGNUMBER_ERROR, BIGNUMBER_POSIX, BIGNUMBER_STAR, LONGFILE_ERROR, LONGFILE_GNU, LONGFILE_POSIX, LONGFILE_TRUNCATE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CompressibleFileImpl(String filename)

Method Summary

Modifier and Type	Method and Description
Compression.CompressedFile	compress() Compress the file into tar.gz.
static Compression.CompressibleWithIgnore	compressToFile(String filename)
String[]	fileList() Get the file list the tar.gz contains.
Compression.CompressibleFile	withDirectory(String directory) Set the directory path to the compressible object.
Compression.CompressibleFile	withFile(String filename) Set the file or directory path to the compressible object.
Compression.CompressibleWithFile	withIgnoreList(String[] ignoreList) Set the compress ignore list.

Methods inherited from class org.apache.commons.compress.archivers.tar.TarArchiveOutputStream

close, closeArchiveEntry, createArchiveEntry, finish, flush, getBytesWritten, getCount, getRecordSize, putArchiveEntry, setAddPaxHeadersForNonAsciiNames, setBigNumberMode, setLongFileMode, write

Methods inherited from class org.apache.commons.compress.archivers.ArchiveOutputStream

canWriteEntryData, count, count, write

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

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

Constructor Detail

CompressibleFileImpl

protected CompressibleFileImpl(String filename)
                        throws IOException

Throws:

IOException

Method Detail

compress

public Compression.CompressedFile compress()
                                    throws IOException

Description copied from interface: Compression.CompressibleFile

Compress the file into tar.gz.

Specified by:

compress in interface Compression.CompressibleFile

Returns:

Compressed file

Throws:

IOException

fileList

public String[] fileList()

Description copied from interface: Compression.CompressedFile

Get the file list the tar.gz contains.

Specified by:

fileList in interface Compression.CompressedFile

Returns:

File list.

withFile

public Compression.CompressibleFile withFile(String filename)
                                      throws IOException

Description copied from interface: Compression.CompressibleWithFile

Set the file or directory path to the compressible object. If the filename is a directory, this directory WILL be compressed into tar.gz zip.

Specified by:

withFile in interface Compression.CompressibleWithFile

Parameters:

filename - Directory or file to be compressed.

Returns:

The Object can be compressed.

Throws:

IOException

withDirectory

public Compression.CompressibleFile withDirectory(String directory)
                                           throws IOException

Description copied from interface: Compression.CompressibleWithFile

Set the directory path to the compressible object. This directory WILL NOT be compressed into tar.gz zip. ALL CHILDREN will be compressed.

Specified by:

withDirectory in interface Compression.CompressibleWithFile

Parameters:

directory - Directory name.

Returns:

The Object can be compressed.

Throws:

IOException

withIgnoreList

public Compression.CompressibleWithFile withIgnoreList(String[] ignoreList)

Description copied from interface: Compression.CompressibleWithIgnore

Set the compress ignore list. The file meets ignore rule will not be added to the archive file.

Specified by:

withIgnoreList in interface Compression.CompressibleWithIgnore

Parameters:

ignoreList - List contains strings like build/.

Returns:

Compressible object.

compressToFile

public static Compression.CompressibleWithIgnore compressToFile(String filename)
                                                         throws IOException

Throws:

IOException