LzipArchive

Inheritance: java.lang.Object

All Implemented Interfaces: com.aspose.zip.IArchive, com.aspose.zip.IArchiveFileEntry, java.lang.AutoCloseable

public class LzipArchive implements IArchive, IArchiveFileEntry, AutoCloseable

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

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.

Methods

Method	Description
close()	{@inheritDoc}
extract(File file)	Extracts lzip archive to a file.
extract(OutputStream destination)	Extracts lzip archive to a stream.
extract(String path)	Extracts lzip archive to a file by path.
extractToDirectory(String destinationDirectory)	Extracts content of the archive to the directory provided.
getFileEntries()	Gets entries of IArchiveFileEntry type constituting the lzip archive.
getFormat()	Gets the archive format.
getLength()	Gets length.
getName()	The name of original file.
getSettings()	Gets the setting of particular lzip archive.
getUncompressedSize()	Gets the uncompressed size of the file data in bytes.
save(File destination)	Saves lzip archive to destination file provided.
save(OutputStream outputStream)	Saves lzip archive to the stream provided.
save(String destinationFileName)	Saves lzip archive to destination file provided.
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.

LzipArchive()

public LzipArchive()

Initializes a new instance of the LzipArchive.

LzipArchive(LzipArchiveSettings settings)

public LzipArchive(LzipArchiveSettings settings)

Initializes a new instance of the LzipArchive.

Parameters:

Parameter	Type	Description
settings	LzipArchiveSettings	the setting of particular lzip archive with definition of dictionary size

LzipArchive(InputStream sourceStream)

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)](../../com.aspose.zip/lziparchive\#extract-OutputStream-) method for decompressing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sourceStream | java.io.InputStream | the source of the archive |

### LzipArchive(InputStream sourceStream, LzipLoadOptions options) {#LzipArchive-java.io.InputStream-com.aspose.zip.LzipLoadOptions-}

public LzipArchive(InputStream sourceStream, LzipLoadOptions options)



Initializes a new instance of the [LzipArchive](../../com.aspose.zip/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)](../../com.aspose.zip/lziparchive\#extract-OutputStream-) method for decompressing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sourceStream | java.io.InputStream | the source of the archive |
| options | [LzipLoadOptions](../../com.aspose.zip/lziploadoptions) | Options to load the archive with. |

### LzipArchive(String path) {#LzipArchive-java.lang.String-}
```
public LzipArchive(String path)
```


Initializes a new instance of the [LzipArchive](../../com.aspose.zip/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)](../../com.aspose.zip/lziparchive\#extract-OutputStream-) method for decompressing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | the path to the source of the archive |

### LzipArchive(String path, LzipLoadOptions options) {#LzipArchive-java.lang.String-com.aspose.zip.LzipLoadOptions-}

public LzipArchive(String path, LzipLoadOptions options)



Initializes a new instance of the [LzipArchive](../../com.aspose.zip/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)](../../com.aspose.zip/lziparchive\#extract-OutputStream-) method for decompressing.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | the path to the source of the archive |
| options | [LzipLoadOptions](../../com.aspose.zip/lziploadoptions) | Options to load the archive with. |

### close() {#close--}
```
public void close()
```




### extract(File file) {#extract-java.io.File-}
```
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:**
| Parameter | Type | Description |
| --- | --- | --- |
| file | java.io.File | the file for storing decompressed data |

### extract(OutputStream destination) {#extract-java.io.OutputStream-}

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) {
     }
 
```



**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| destination | java.io.OutputStream | the stream for storing decompressed data |

### extract(String path) {#extract-java.lang.String-}
```
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) {
 }




**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | the path to the file which will store decompressed data |

**Returns:**
java.io.File - the file info of the extracted file
### extractToDirectory(String destinationDirectory) {#extractToDirectory-java.lang.String-}

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() {#getFileEntries--}

public final Iterable getFileEntries()



Gets entries of [IArchiveFileEntry](../../com.aspose.zip/iarchivefileentry) type constituting the lzip archive.

**Returns:**
java.lang.Iterable&lt;com.aspose.zip.IArchiveFileEntry&gt; - entries of [IArchiveFileEntry](../../com.aspose.zip/iarchivefileentry) type constituting the lzip archive
### getFormat() {#getFormat--}

public final ArchiveFormat getFormat()



Gets the archive format.

**Returns:**
[ArchiveFormat](../../com.aspose.zip/archiveformat) - the archive format
### getLength() {#getLength--}

public final Long getLength()



Gets length.

**Returns:**
java.lang.Long - length
### getName() {#getName--}

public final String getName()



The name of original file.

**Returns:**
java.lang.String - the name of the original file
### getSettings() {#getSettings--}

public final LzipArchiveSettings getSettings()



Gets the setting of particular lzip archive.

**Returns:**
[LzipArchiveSettings](../../com.aspose.zip/lziparchivesettings) - the setting of particular lzip archive
### getUncompressedSize() {#getUncompressedSize--}

public final long getUncompressedSize()



Gets the uncompressed size of the file data in bytes.

**Returns:**
long - the uncompressed size of the file data in bytes
### save(File destination) {#save-java.io.File-}

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:**
| Parameter | Type | Description |
| --- | --- | --- |
| destination | java.io.File | the file, which will be opened as destination stream |

### save(OutputStream outputStream) {#save-java.io.OutputStream-}
```
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:**
| Parameter | Type | Description |
| --- | --- | --- |
| outputStream | java.io.OutputStream | destination stream |

### save(String destinationFileName) {#save-java.lang.String-}

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:**
| 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(File file) {#setSource-java.io.File-}
```
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:**
| Parameter | Type | Description |
| --- | --- | --- |
| file | java.io.File | the file which will be opened as input stream |

### setSource(InputStream source) {#setSource-java.io.InputStream-}

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:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.io.InputStream | the input stream for the archive |

### setSource(String path) {#setSource-java.lang.String-}
```
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:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | the path to the file to be compressed |

Lz4LoadOptions LzipArchiveSettings