Package com.aspose.zip

Class LzipArchive

java.lang.Object

com.aspose.zip.LzipArchive

All Implemented Interfaces:

IArchive, IArchiveFileEntry, AutoCloseable

public class LzipArchive
extends Object
implements IArchive, IArchiveFileEntry, AutoCloseable

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

Constructor Summary

Constructors

Constructor	Description
LzipArchive()	Initializes a new instance of the LzipArchive.
LzipArchive(LzipArchiveSettings settings)	Initializes a new instance of the LzipArchive.
LzipArchive(InputStream sourceStream)	Initializes a new instance of the LzipArchive class prepared for decompressing.
LzipArchive(InputStream sourceStream, LzipLoadOptions options)	Initializes a new instance of the LzipArchive class prepared for decompressing.
LzipArchive(String path)	Initializes a new instance of the LzipArchive class prepared for decompressing.
LzipArchive(String path, LzipLoadOptions options)	Initializes a new instance of the LzipArchive class prepared for decompressing.

Method Summary

Modifier and Type	Method	Description
void	close()
void	extract(File file)	Extracts lzip archive to a file.
void	extract(OutputStream destination)	Extracts lzip archive to a stream.
File	extract(String path)	Extracts lzip archive to a file by path.
void	extractToDirectory(String destinationDirectory)	Extracts content of the archive to the directory provided.
Iterable<IArchiveFileEntry>	getFileEntries()	Gets entries of IArchiveFileEntry type constituting the lzip archive.
ArchiveFormat	getFormat()	Gets the archive format.
Long	getLength()	Gets length.
String	getName()	The name of original file.
LzipArchiveSettings	getSettings()	Gets the setting of particular lzip archive.
void	save(File destination)	Saves lzip archive to destination file provided.
void	save(OutputStream outputStream)	Saves lzip archive to the stream provided.
void	save(String destinationFileName)	Saves lzip archive to destination file provided.
void	setSource(File file)	Sets the content to be compressed within the archive.
void	setSource(InputStream source)	Sets the content to be compressed within the archive.
void	setSource(String path)	Sets the content to be compressed within the archive.

Methods inherited from class java.lang.Object

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

Constructor Detail

LzipArchive

public LzipArchive()

Initializes a new instance of the LzipArchive.

LzipArchive

public LzipArchive(LzipArchiveSettings settings)

Initializes a new instance of the LzipArchive.

Parameters:

settings - the setting of particular lzip archive with definition of dictionary size

LzipArchive

public LzipArchive(InputStream sourceStream)

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

     try (FileInputStream sourceLzipFile = new FileInputStream("sourceLzipFile")) {
         try (FileOutputStream extractedFile = new FileOutputStream("extractedFileName")) {
             try (LzipArchive archive = new LzipArchive(sourceLzipFile)) {
                 archive.extract(extractedFile);
             }
         }
     } catch (IOException ex) {
     }
 

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

Parameters:

sourceStream - the source of the archive

Throws:

com.aspose.ms.System.ArgumentException - sourceStream is not seekable.

com.aspose.ms.System.ArgumentNullException - sourceStream is null.

com.aspose.ms.System.IO.InvalidDataException - Headers do not match lzip type of archive.

LzipArchive

public LzipArchive(InputStream sourceStream,
                   LzipLoadOptions options)

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

     try (FileInputStream sourceLzipFile = new FileInputStream("sourceLzipFile")) {
         try (FileOutputStream extractedFile = new FileOutputStream("extractedFileName")) {
             try (LzipArchive archive = new LzipArchive(sourceLzipFile)) {
                 archive.extract(extractedFile);
             }
         }
     } catch (IOException ex) {
     }
 

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

Parameters:

sourceStream - the source of the archive

options - Options to load the archive with.

Throws:

com.aspose.ms.System.ArgumentException - sourceStream is not seekable.

com.aspose.ms.System.ArgumentNullException - sourceStream is null.

com.aspose.ms.System.IO.InvalidDataException - Headers do not match lzip type of archive.

LzipArchive

public LzipArchive(String path)

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

     try (FileOutputStream extractedFile = new FileOutputStream("extractedFileName")) {
         try (LzipArchive archive = new LzipArchive("sourceLzipFileName")) {
             archive.extract(extractedFile);
         }
     } catch (IOException ex) {
     }
 

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

Parameters:

path - the path to the source of the archive

Throws:

com.aspose.ms.System.ArgumentNullException - path is null.

com.aspose.ms.System.SecurityException - The caller does not have the required permission to access.

com.aspose.ms.System.ArgumentException - The path is empty, contains only white spaces, or contains invalid characters.

com.aspose.ms.System.IO.PathTooLongException - The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.

com.aspose.ms.System.NotSupportedException - File at path contains a colon (:) in the middle of the string.

com.aspose.ms.System.IO.FileNotFoundException - The file is not found.

com.aspose.ms.System.IO.DirectoryNotFoundException - The specified path is invalid, such as being on an unmapped drive.

com.aspose.ms.System.IO.IOException - The file is already open.

com.aspose.ms.System.IO.InvalidDataException - Headers do not match lzip type of archive.

LzipArchive

public LzipArchive(String path,
                   LzipLoadOptions options)

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

     try (FileOutputStream extractedFile = new FileOutputStream("extractedFileName")) {
         try (LzipArchive archive = new LzipArchive("sourceLzipFileName")) {
             archive.extract(extractedFile);
         }
     } catch (IOException ex) {
     }
 

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

Parameters:

path - the path to the source of the archive

options - Options to load the archive with.

Throws:

com.aspose.ms.System.ArgumentNullException - path is null.

com.aspose.ms.System.SecurityException - The caller does not have the required permission to access.

com.aspose.ms.System.ArgumentException - The path is empty, contains only white spaces, or contains invalid characters.

com.aspose.ms.System.IO.PathTooLongException - The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.

com.aspose.ms.System.NotSupportedException - File at path contains a colon (:) in the middle of the string.

com.aspose.ms.System.IO.FileNotFoundException - The file is not found.

com.aspose.ms.System.IO.DirectoryNotFoundException - The specified path is invalid, such as being on an unmapped drive.

com.aspose.ms.System.IO.IOException - The file is already open.

com.aspose.ms.System.IO.InvalidDataException - Headers do not match lzip type of archive.

Method Detail

getFileEntries

public final Iterable<IArchiveFileEntry> getFileEntries()

Gets entries of IArchiveFileEntry type constituting the lzip archive.

Specified by:

getFileEntries in interface IArchive

Returns:

entries of IArchiveFileEntry type constituting the lzip archive

getFormat

public final ArchiveFormat getFormat()

Gets the archive format.

Specified by:

getFormat in interface IArchive

Returns:

the archive format

getSettings

public final LzipArchiveSettings getSettings()

Gets the setting of particular lzip archive.

Returns:

the setting of particular lzip archive

getName

public final String getName()

The name of original file.

Specified by:

getName in interface IArchiveFileEntry

Returns:

the name of the original file

getLength

public final Long getLength()

Gets length.

Specified by:

getLength in interface IArchiveFileEntry

Returns:

length

extract

public final void extract(OutputStream destination)

Extracts lzip archive to a stream.

     try (FileInputStream sourceLzipFile = new FileInputStream("sourceLzipFile")) {
         try (FileOutputStream extractedFile = new FileOutputStream("extractedFileName")) {
             try (LzipArchive archive = new LzipArchive(sourceLzipFile)) {
                 archive.extract(extractedFile);
             }
         }
     } catch (IOException ex) {
     }
 

Specified by:

extract in interface IArchiveFileEntry

Parameters:

destination - the stream for storing decompressed data

Throws:

com.aspose.ms.System.InvalidOperationException - Archive headers and service information were not read.

com.aspose.ms.System.IO.InvalidDataException - Error in data in header or checksum.

com.aspose.ms.System.ArgumentNullException - Destination stream is null.

com.aspose.ms.System.ArgumentException - Destination stream does not support writing.

extract

public final void extract(File file)

Extracts lzip archive to a file.

     try (FileInputStream lzipFile = new FileInputStream("sourceFileName")) {
         try (LzipArchive archive = new LzipArchive(lzipFile)) {
             archive.extract(new File("extracted.bin"));
         }
     } catch (IOException ex) {
     }
 

Parameters:

file - the file for storing decompressed data

Throws:

com.aspose.ms.System.InvalidOperationException - Archive headers and service information were not read.

com.aspose.ms.System.SecurityException - The caller does not have the required permission to open the file.

com.aspose.ms.System.ArgumentException - The file path is empty or contains only white spaces.

com.aspose.ms.System.IO.FileNotFoundException - The file is not found.

com.aspose.ms.System.ArgumentNullException - file is null.

com.aspose.ms.System.IO.DirectoryNotFoundException - The specified path is invalid, such as being on an unmapped drive.

com.aspose.ms.System.IO.IOException - The file is already open.

extract

public final File extract(String path)

Extracts lzip archive to a file by path.

     try (FileInputStream lzipFile = new FileInputStream("sourceFileName")) {
         try (LzipArchive archive = new LzipArchive(lzipFile)) {
             archive.extract("extracted.bin");
         }
     } catch (IOException ex) {
     }
 

Specified by:

extract in interface IArchiveFileEntry

Parameters:

path - the path to the file which will store decompressed data

Returns:

the file info of the extracted file

Throws:

com.aspose.ms.System.InvalidOperationException - Archive headers and service information were not read.

com.aspose.ms.System.ArgumentNullException - path is null.

com.aspose.ms.System.SecurityException - The caller does not have the required permission to access.

com.aspose.ms.System.ArgumentException - The path is empty, contains only white spaces, or contains invalid characters.

com.aspose.ms.System.IO.PathTooLongException - The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.

com.aspose.ms.System.NotSupportedException - File at path contains a colon (:) in the middle of the string.

extractToDirectory

public final void extractToDirectory(String destinationDirectory)

Extracts content of the archive to the directory provided.

Specified by:

extractToDirectory in interface IArchive

Parameters:

destinationDirectory - the path to the directory to place the extracted files in.

If the directory does not exist, it will be created

Throws:

com.aspose.ms.System.ArgumentNullException - destinationDirectory is null.

com.aspose.ms.System.IO.PathTooLongException - The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters and file names must be less than 260 characters.

com.aspose.ms.System.SecurityException - The caller does not have the required permission to access the existing directory.

com.aspose.ms.System.NotSupportedException - If the directory does not exist, the path contains a colon character (:) that is not part of a drive label ("C:\").

com.aspose.ms.System.ArgumentException - destinationDirectory is a zero-length string, contains only white space, or contains one or more invalid characters.

com.aspose.ms.System.IO.IOException - The directory specified by path is a file or the network name is not known.

save

public final void save(OutputStream outputStream)

Saves lzip archive to the stream provided.

     try (FileOutputStream lzFile = new FileOutputStream("archive.lz")) {
         try (LzipArchive archive = new LzipArchive()) {
             archive.setSource("data.bin");
             archive.save(lzFile);
         }
     } catch (IOException ex) {
     }
 

Parameters:

outputStream - destination stream

Throws:

com.aspose.ms.System.ArgumentException - outputStream does not support seeking.

com.aspose.ms.System.ArgumentNullException - outputStream is null.

setSource

public final void setSource(InputStream source)

Sets the content to be compressed within the archive.

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

Parameters:

source - the input stream for the archive

Throws:

com.aspose.ms.System.ArgumentException - The source stream is unseekable.

setSource

public final void setSource(File file)

Sets the content to be compressed within the archive.

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

Parameters:

file - the file which will be opened as input stream

Throws:

com.aspose.ms.System.SecurityException - The caller does not have the required permission to open the file.

com.aspose.ms.System.ArgumentException - File path is empty or contains only white spaces.

com.aspose.ms.System.IO.FileNotFoundException - The file is not found.

com.aspose.ms.System.ArgumentNullException - file is null.

com.aspose.ms.System.IO.DirectoryNotFoundException - The specified path is invalid, such as being on an unmapped drive.

com.aspose.ms.System.IO.IOException - The file is already open.

setSource

public final void setSource(String path)

Sets the content to be compressed within the archive.

     try (LzipArchive archive = new LzipArchive()) {
         archive.setSource("data.bin");
         archive.save("archive.lz");
     }
 

Parameters:

path - the path to the file to be compressed

Throws:

com.aspose.ms.System.ArgumentNullException - path is null.

com.aspose.ms.System.SecurityException - The caller does not have the required permission to access.

com.aspose.ms.System.ArgumentException - The path is empty, contains only white spaces, or contains invalid characters.

com.aspose.ms.System.IO.PathTooLongException - The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.

com.aspose.ms.System.NotSupportedException - File at path contains a colon (:) in the middle of the string.

save

public final void save(String destinationFileName)

Saves lzip archive to destination file provided.

     try (LzipArchive archive = new LzipArchive()) {
         archive.setSource(new File("data.bin"));
         archive.save("result.lz");
     }
 

Parameters:

destinationFileName - the path of the archive to be created. If the specified file name points to an existing file, it will be overwritten

Throws:

com.aspose.ms.System.ArgumentNullException - destinationFileName is null.

com.aspose.ms.System.SecurityException - The caller does not have the required permission to access.

com.aspose.ms.System.ArgumentException - The destinationFileName is empty, contains only white spaces, or contains invalid characters.

com.aspose.ms.System.IO.PathTooLongException - The specified destinationFileName, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.

com.aspose.ms.System.NotSupportedException - File at destinationFileName contains a colon (:) in the middle of the string.

save

public final void save(File destination)

Saves lzip archive to destination file provided.

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

Parameters:

destination - the file, which will be opened as destination stream

Throws:

com.aspose.ms.System.SecurityException - The caller does not have the required permission to open the destination.

com.aspose.ms.System.ArgumentException - The file path is empty or contains only white spaces.

com.aspose.ms.System.IO.FileNotFoundException - The file is not found.

com.aspose.ms.System.ArgumentNullException - destination is null.

com.aspose.ms.System.IO.DirectoryNotFoundException - The specified path is invalid, such as being on an unmapped drive.

com.aspose.ms.System.IO.IOException - The file is already open.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IArchive