SnappyArchive

Inheritance: java.lang.Object

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

public class SnappyArchive implements IArchive, IArchiveFileEntry, AutoCloseable

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

Constructors

Constructor	Description
SnappyArchive()	Initializes a new instance of the SnappyArchive class prepared for compressing.
SnappyArchive(InputStream source)	Initializes a new instance of the SnappyArchive class prepared for decompressing.
SnappyArchive(String path)	Initializes a new instance of the SnappyArchive class prepared for decompressing.

Methods

Method	Description
close()	{@inheritDoc}
extract(File file)	Extracts snappy archive to a file.
extract(OutputStream destination)	Extracts snappy archive to a stream.
extract(String path)	Extracts snappy 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 snappy archive.
getFormat()	Gets the archive format.
getLength()	Gets length.
getName()	The name of original file.
save(File destination)	Saves snappy archive to the destination file provided.
save(OutputStream output)	Saves snappy archive to the stream provided.
save(String destinationFileName)	Saves snappy archive to the 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 sourcePath)	Sets the content to be compressed within the archive.

SnappyArchive()

public SnappyArchive()

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

The following example shows how to compress a file.

 try (SnappyArchive archive = new SnappyArchive()) {
     archive.setSource("data.bin");
     archive.save("archive.snappy");
 }




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

public SnappyArchive(InputStream source)



Initializes a new instance of the [SnappyArchive](../../com.aspose.zip/snappyarchive) class prepared for decompressing.

This constructor does not decompress. See [extract(java.io.OutputStream)](../../com.aspose.zip/snappyarchive\#extract-java.io.OutputStream-) method for decompressing.

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

### SnappyArchive(String path) {#SnappyArchive-java.lang.String-}

public SnappyArchive(String path)



Initializes a new instance of the [SnappyArchive](../../com.aspose.zip/snappyarchive) class prepared for decompressing.


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

This constructor does not decompress. See [extract(java.io.OutputStream)](../../com.aspose.zip/snappyarchive\#extract-java.io.OutputStream-) method for decompressing.

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

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




### extract(File file) {#extract-java.io.File-}
```
public final void extract(File file)
```


Extracts snappy archive to a file.

```

 try (FileInputStream snappyFile = new FileInputStream("sourceFileName")) {
     try (SnappyArchive archive = new SnappyArchive(snappyFile)) {
         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 snappy archive to a stream.


     try (FileInputStream sourceSnappyFile = new FileInputStream("sourceFileName")) {
         try (FileOutputStream extractedFile = new FileOutputStream("extractedFileName")) {
             try (SnappyArchive archive = new SnappyArchive(sourceSnappyFile)) {
                 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 snappy archive to a file by path.

```

 try (FileInputStream snappyFile = new FileInputStream("sourceFileName")) {
     try (SnappyArchive archive = new SnappyArchive(snappyFile)) {
         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 - java.io.File instance containing extracted data
### 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 snappy archive.

**Returns:**
java.lang.Iterable&lt;com.aspose.zip.IArchiveFileEntry&gt; - entries of [IArchiveFileEntry](../../com.aspose.zip/iarchivefileentry) type constituting the snappy 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
### save(File destination) {#save-java.io.File-}

public final void save(File destination)



Saves snappy archive to the destination file provided.


     try (SnappyArchive archive = new SnappyArchive()) {
         archive.setSource(new File("data.bin"));
         archive.save(new File("archive.snappy"));
     }
 
```



**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| destination | java.io.File | the file, which will be opened as a destination stream |

### save(OutputStream output) {#save-java.io.OutputStream-}
```
public final void save(OutputStream output)
```


Saves snappy archive to the stream provided.

```

 try (FileOutputStream snappyFile = new FileOutputStream("archive.snappy")) {
     try (SnappyArchive archive = new SnappyArchive()) {
         archive.setSource("data.bin");
         archive.save(snappyFile);
     }
 } catch (IOException ex) {
 }




**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| output | java.io.OutputStream | the destination stream |

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

public final void save(String destinationFileName)



Saves snappy archive to the destination file provided.


     try (SnappyArchive archive = new SnappyArchive()) {
         archive.setSource(new File("data.bin"));
         archive.save("result.snappy");
     }
 
```



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




**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| file | java.io.File | the file which will be opened as an 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 (SnappyArchive archive = new SnappyArchive()) {
         archive.setSource(new ByteArrayInputStream(new byte[] {
                 0x00,
                 (byte) 0xFF
         }));
         archive.save("archive.snappy");
     }
 
```



**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| source | java.io.InputStream | the input stream for the archive |

### setSource(String sourcePath) {#setSource-java.lang.String-}
```
public final void setSource(String sourcePath)
```


Sets the content to be compressed within the archive.

```

 try (SnappyArchive archive = new SnappyArchive()) {
     archive.setSource("data.bin");
     archive.save("archive.snappy");
 }




**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sourcePath | java.lang.String | the path to the file which will be opened as an input stream |

SharEntry SplitArchiveSaveOptions