GzipArchive

Inheritance: java.lang.Object, com.aspose.zip.ILicenseStateProvider

All Implemented Interfaces: com.aspose.ms.System.IDisposable, com.aspose.zip.IArchive, java.lang.AutoCloseable

public class GzipArchive extends ILicenseStateProvider implements System.IDisposable, IArchive, AutoCloseable

This class represents gzip archive file. Use it to compose or extract gzip archives.

Gzip compression algorithm is based on the DEFLATE algorithm, which is a combination of LZ77 and Huffman coding.

Constructors

Constructor	Description
GzipArchive()	Initializes a new instance of the GzipArchive class prepared for compressing.
GzipArchive(InputStream sourceStream)	Initializes a new instance of the GzipArchive class prepared for decompressing.
GzipArchive(InputStream sourceStream, boolean parseHeader)	Initializes a new instance of the GzipArchive class prepared for decompressing.
GzipArchive(String path)	Initializes a new instance of the GzipArchive class.
GzipArchive(String path, boolean parseHeader)	Initializes a new instance of the GzipArchive class.

Methods

Method	Description
close()	{@inheritDoc}
dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
extract(OutputStream destination)	Extracts the archive to the stream provided.
extract(String path)	Extracts the archive to the file by path.
extractToDirectory(String destinationDirectory)	Extracts content of the archive to the directory provided.
getFileEntries()	Gets entries of IArchiveFileEntry type constituting the gzip archive.
getName()	Name of original file.
open()	Opens the archive for extraction and provides a stream with archive content.
save(OutputStream outputStream)	Saves archive to the stream provided.
save(String destinationFileName)	Saves archive to destination file provided.
setSource(TarArchive tarArchive)	Sets the content to be compressed within the archive.
setSource(File file)	Sets the content to be compressed within the archive.
setSource(InputStream source)	Sets the content to be compressed within the archive.
setSource(String path)	Sets the content to be compressed within the archive.

GzipArchive()

public GzipArchive()

Initializes a new instance of the GzipArchive class prepared for compressing.

The following example shows how to compress a file.


     try (GzipArchive archive = new GzipArchive())
     {
         archive.setSource("data.bin");
         archive.save("archive.gz");
     }

GzipArchive(InputStream sourceStream)

public GzipArchive(InputStream sourceStream)

Initializes a new instance of the GzipArchive class prepared for decompressing.

Open an archive from a stream and extract it to a MemoryStream


     ByteArrayOutputStream ms = new ByteArrayOutputStream();
     try (GzipArchive archive = new GzipArchive(Files.newInputStream(java.nio.file.Paths.get("archive.gz")))) {
         byte[] b = new byte[8192];
         int bytesRead;
         InputStream archiveStream = archive.open();
         while (0 < (bytesRead = archiveStream.read(b, 0, b.length))) {
             ms.write(b, 0, bytesRead);
         }
     } catch (IOException ex) {
         System.out.println(ex);
     }

This constructor does not decompress. See open() method for decompressing.

Parameters:

Parameter	Type	Description
sourceStream	java.io.InputStream	The source of the archive.

GzipArchive(InputStream sourceStream, boolean parseHeader)

public GzipArchive(InputStream sourceStream, boolean parseHeader)

Initializes a new instance of the GzipArchive class prepared for decompressing.

Open an archive from a stream and extract it to a MemoryStream


     ByteArrayOutputStream ms = new ByteArrayOutputStream();
     try (GzipArchive archive = new GzipArchive(Files.newInputStream(java.nio.file.Paths.get("archive.gz")))) {
         byte[] b = new byte[8192];
         int bytesRead;
         InputStream archiveStream = archive.open();
         while (0 < (bytesRead = archiveStream.read(b, 0, b.length))) {
             ms.write(b, 0, bytesRead);
         }
     } catch (IOException ex) {
         System.out.println(ex);
     }

This constructor does not decompress. See open() method for decompressing.

Parameters:

Parameter	Type	Description
sourceStream	java.io.InputStream	The source of the archive.
parseHeader	boolean	Whether to parse stream header to figure out properties, including name. Makes sense for seekable stream only.

GzipArchive(String path)

public GzipArchive(String path)

Initializes a new instance of the GzipArchive class.

Open an archive from file by path and extract it to a MemoryStream


     ByteArrayOutputStream ms = new ByteArrayOutputStream();
     try (GzipArchive archive = new GzipArchive("archive.gz")) {
         byte[] b = new byte[8192];
         int bytesRead;
         InputStream archiveStream = archive.open();
         while (0 < (bytesRead = archiveStream.read(b, 0, b.length))) {
             ms.write(b, 0, bytesRead);
         }
     } catch (IOException ex) {
         System.out.println(ex);
     }

This constructor does not decompress. See open() method for decompressing.

Parameters:

Parameter	Type	Description
path	java.lang.String	The path to the archive file.

GzipArchive(String path, boolean parseHeader)

public GzipArchive(String path, boolean parseHeader)

Initializes a new instance of the GzipArchive class.

Open an archive from file by path and extract it to a MemoryStream


     ByteArrayOutputStream ms = new ByteArrayOutputStream();
     try (GzipArchive archive = new GzipArchive("archive.gz")) {
         byte[] b = new byte[8192];
         int bytesRead;
         InputStream archiveStream = archive.open();
         while (0 < (bytesRead = archiveStream.read(b, 0, b.length))) {
             ms.write(b, 0, bytesRead);
         }
     } catch (IOException ex) {
         System.out.println(ex);
     }

This constructor does not decompress. See open() method for decompressing.

Parameters:

Parameter	Type	Description
path	java.lang.String	The path to the archive file.
parseHeader	boolean	Whether to parse stream header to figure out properties, including name. Makes sense for seekable stream only.

close()

public void close()

dispose()

public final void dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

extract(OutputStream destination)

public final void extract(OutputStream destination)

Extracts the archive to the stream provided.


     try (GzipArchive archive = new GzipArchive("archive.gz")) {
         archive.extract(httpResponseStream);
     }

Parameters:

Parameter	Type	Description
destination	java.io.OutputStream	Destination stream. Must be writable.

extract(String path)

public final File extract(String path)

Extracts the archive to the file by path.

Parameters:

Parameter	Type	Description
path	java.lang.String	The path to destination file. If the file already exists, it will be overwritten.

Returns: java.io.File - Info of extracted file.

extractToDirectory(String destinationDirectory)

public final void extractToDirectory(String destinationDirectory)

Extracts content of the archive to the directory provided.

Parameters:

Parameter	Type	Description
destinationDirectory	java.lang.String	The path to the directory to place the extracted files in.

If the directory does not exist, it will be created. |

getFileEntries()

public final Iterable<IArchiveFileEntry> getFileEntries()

Gets entries of IArchiveFileEntry type constituting the gzip archive.

Returns: java.lang.Iterable<com.aspose.zip.IArchiveFileEntry> - entries of IArchiveFileEntry type constituting the gzip archive.

getName()

public final String getName()

Name of original file.

Returns: java.lang.String - the name of the original file.

open()

public final InputStream open()

Opens the archive for extraction and provides a stream with archive content.

Extracts the archive and copies extracted content to file stream.


     try (GzipArchive archive = new GzipArchive("archive.gz")) {
         try (FileOutputStream extracted = new FileOutputStream("data.bin")) {
             InputStream unpacked = archive.open();
             byte[] b = new byte[8192];
             int bytesRead;
             while (0 < (bytesRead = unpacked.read(b, 0, b.length))) {
                 extracted.write(b, 0, bytesRead);
             }
         }
     } catch (IOException ex) {
         System.out.println(ex);
     }

Read from the stream to get original content of file. See examples section.

Returns: java.io.InputStream - The stream that represents the contents of the archive.

save(OutputStream outputStream)

public final void save(OutputStream outputStream)

Saves archive to the stream provided.

Writes compressed data to http response stream.


     try (GzipArchive archive = new GzipArchive()) {
         archive.setSource(new File("data.bin"));
         archive.save(httpResponseStream);
     }

Parameters:

Parameter	Type	Description
outputStream	java.io.OutputStream	Destination stream.

outputStream must be writable. |

save(String destinationFileName)

public final void save(String destinationFileName)

Saves archive to destination file provided.


     try (GzipArchive archive = new GzipArchive()) {
         archive.setSource("data.bin");
         archive.save("archive.gz");
     }

Parameters:

Parameter	Type	Description
destinationFileName	java.lang.String	The path of the archive to be created. If the specified file name points to an existing file, it will be overwritten.

setSource(TarArchive tarArchive)

public final void setSource(TarArchive tarArchive)

Sets the content to be compressed within the archive.


     try (TarArchive tarArchive = new TarArchive()) {
         tarArchive.createEntry("first.bin", "data1.bin");
         tarArchive.createEntry("second.bin", "data2.bin");
         try (GzipArchive gzippedArchive = new GzipArchive()) {
             gzippedArchive.setSource(tarArchive);
             gzippedArchive.save("archive.tar.gz");
         }
     }

Use this method to compose joint tar.gz archive.

Parameters:

Parameter	Type	Description
tarArchive	TarArchive	Tar archive to be compressed.

setSource(File file)

public final void setSource(File file)

Sets the content to be compressed within the archive.


     try (GzipArchive archive = new GzipArchive()) {
         archive.setSource(new File("data.bin"));
         archive.save("archive.gz");
     }

Parameters:

Parameter	Type	Description
file	java.io.File	The reference to a file to be compressed.

setSource(InputStream source)

public final void setSource(InputStream source)

Sets the content to be compressed within the archive.


     try (GzipArchive archive = new GzipArchive()) {
         archive.setSource(new ByteArrayInputStream(new byte[] {
                 0x00,
                 (byte) 0xFF
         }));
         archive.save("archive.gz");
     }

Parameters:

Parameter	Type	Description
source	java.io.InputStream	The input stream for the archive.

setSource(String path)

public final void setSource(String path)

Sets the content to be compressed within the archive.

Open an archive from file by path and extract it to a MemoryStream


     try (GzipArchive archive = new GzipArchive()) {
         archive.setSource("data.bin");
         archive.save("archive.gz");
     }

Parameters:

Parameter	Type	Description
path	java.lang.String	Path to file to be compressed.

EventsBag License