Package com.aspose.zip

Class XzArchive

java.lang.Object

com.aspose.zip.XzArchive

All Implemented Interfaces:

IArchive, IArchiveFileEntry, AutoCloseable

public class XzArchive
extends Object
implements IArchiveFileEntry, IArchive, AutoCloseable

This class represents xz archive file. Use it to compose and extract xz archives.

Constructor Summary

Constructors

Constructor	Description
XzArchive()	Initializes a new instance of the XzArchive class and composes the archive in xz format.
XzArchive(XzArchiveSettings settings)	Initializes a new instance of the XzArchive class and composes the archive in xz format.
XzArchive(InputStream source)	Initializes a new instance of the XzArchive class prepared for decompressing.
XzArchive(InputStream source, XzLoadOptions options)	Initializes a new instance of the XzArchive class prepared for decompressing.
XzArchive(String path)	Initializes a new instance of the XzArchive class prepared for decompressing.
XzArchive(String path, XzLoadOptions options)	Initializes a new instance of the XzArchive class prepared for decompressing.

Method Summary

Modifier and Type	Method	Description
void	close()
void	extract(File file)	Extracts xz archive to a file.
void	extract(OutputStream destination)	Extracts xz archive to a stream.
File	extract(String path)	Extracts xz 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 xz archive.
ArchiveFormat	getFormat()	Gets the archive format.
Long	getLength()	Gets the length of the entry in bytes.
String	getName()	Gets the name of the entry within archive.
void	save(OutputStream output)	Saves xz archive to the stream provided.
void	save(String destinationFileName)	Saves xz archive to the 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 sourcePath)	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

XzArchive

public XzArchive()

Initializes a new instance of the XzArchive class and composes the archive in xz format.

XzArchive

public XzArchive(XzArchiveSettings settings)

Initializes a new instance of the XzArchive class and composes the archive in xz format.

Parameters:

settings - set of setting particular xz archive: dictionary size, block size, check type

XzArchive

public XzArchive(InputStream source)

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

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

Parameters:

source - the source of the archive

Throws:

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

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

XzArchive

public XzArchive(InputStream source,
                 XzLoadOptions options)

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

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

Parameters:

source - the source of the archive

options - Options to load the archive with.

Throws:

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

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

XzArchive

public XzArchive(String path)

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

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

Parameters:

path - 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.

XzArchive

public XzArchive(String path,
                 XzLoadOptions options)

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

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

Parameters:

path - 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.

Method Detail

getName

public final String getName()

Gets the name of the entry within archive.

Specified by:

getName in interface IArchiveFileEntry

Returns:

the name of the entry within archive

getLength

public final Long getLength()

Gets the length of the entry in bytes.

Specified by:

getLength in interface IArchiveFileEntry

Returns:

the length of the entry in bytes

getFileEntries

public final Iterable<IArchiveFileEntry> getFileEntries()

Gets entries of IArchiveFileEntry type constituting the xz archive.

Specified by:

getFileEntries in interface IArchive

Returns:

entries of IArchiveFileEntry type constituting the xz archive

getFormat

public final ArchiveFormat getFormat()

Gets the archive format.

Specified by:

getFormat in interface IArchive

Returns:

the archive format

extract

public final void extract(OutputStream destination)

Extracts xz archive to a stream.

     try (FileInputStream xzFile = new FileInputStream("sourceFileName")) {
         try (FileOutputStream extractedFile = new FileOutputStream("extractedFileName")) {
             try (XzArchive archive = new XzArchive(xzFile)) {
                 archive.extract(extractedFile);
             }
         }
     } catch (IOException ex) {
     }
 

Specified by:

extract in interface IArchiveFileEntry

Parameters:

destination - stream for storing decompressed data

Throws:

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

extract

public final void extract(File file)

Extracts xz archive to a file.

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

Parameters:

file - 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 - 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.

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.

extract

public final File extract(String path)

Extracts xz archive to a file by path.

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

Specified by:

extract in interface IArchiveFileEntry

Parameters:

path - path to file which will store decompressed data

Returns:

File instance containing extracted data

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.

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.

setSource

public final void setSource(InputStream source)

Sets the content to be compressed within the archive.

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

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 (XzArchive archive = new XzArchive()) {
         archive.setSource(new File("data.bin"));
         archive.save("archive.xz");
     }
 

Parameters:

file - 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 - 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.

setSource

public final void setSource(String sourcePath)

Sets the content to be compressed within the archive.

     try (XzArchive archive = new XzArchive()) {
         archive.setSource("data.bin");
         archive.save("archive.xz");
     }
 

Parameters:

sourcePath - path to file which will be opened as input stream

Throws:

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

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

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

com.aspose.ms.System.IO.PathTooLongException - The specified sourcePath, 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 sourcePath contains a colon (:) in the middle of the string.

save

public final void save(OutputStream output)

Saves xz archive to the stream provided.

     try (FileOutputStream xzFile = new FileOutputStream("archive.xz")) {
         try (XzArchive archive = new XzArchive()) {
             archive.setSource("data.bin");
             archive.save(xzFile);
         }
     } catch (IOException ex) {
     }
 

Parameters:

output - destination stream

Throws:

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

save

public final void save(String destinationFileName)

Saves xz archive to the destination file provided.

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

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.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface IArchive