XzArchive

Inheritance: java.lang.Object

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

public class XzArchive implements IArchiveFileEntry, IArchive, AutoCloseable

Denna klass representerar en xz-arkivfil. Använd den för att skapa och extrahera xz-arkiv.

Konstruktörer

KonstruktorBeskrivning
XzArchive()Initierar en ny instans av klassen XzArchive och skapar arkivet i xz-format.
XzArchive(XzArchiveSettings settings)Initierar en ny instans av klassen XzArchive och skapar arkivet i xz-format.
XzArchive(InputStream source)Initierar en ny instans av klassen XzArchive för dekomprimering.
XzArchive(InputStream source, XzLoadOptions options)Initierar en ny instans av klassen XzArchive för dekomprimering.
XzArchive(String path)Initierar en ny instans av klassen XzArchive för dekomprimering.
XzArchive(String path, XzLoadOptions options)Initierar en ny instans av klassen XzArchive för dekomprimering.

Metoder

MetodBeskrivning
close(){@inheritDoc}
extract(File file)Extraherar xz-arkivet till en fil.
extract(OutputStream destination)Extraherar xz-arkivet till en ström.
extract(String path)Extraherar xz-arkivet till en fil via sökväg.
extractToDirectory(String destinationDirectory)Extraherar arkivets innehåll till den angivna katalogen.
getFileEntries()Hämtar poster av typen IArchiveFileEntry som utgör xz-arkivet.
getFormat()Hämtar arkivformatet.
getLength()Hämtar längden på posten i byte.
getName()Hämtar namnet på posten i arkivet.
getUncompressedSize()Hämtar den okomprimerade storleken på fildatan i byte.
save(OutputStream output)Sparar xz-arkivet till den angivna strömmen.
save(String destinationFileName)Sparar xz-arkivet till den angivna destinationsfilen.
setSource(File file)Ställer in innehållet som ska komprimeras i arkivet.
setSource(InputStream source)Ställer in innehållet som ska komprimeras i arkivet.
setSource(String sourcePath)Ställer in innehållet som ska komprimeras i arkivet.

XzArchive()

public XzArchive()

Initierar en ny instans av klassen XzArchive och skapar arkivet i xz-format.

XzArchive(XzArchiveSettings settings)

public XzArchive(XzArchiveSettings settings)

Initierar en ny instans av klassen XzArchive och skapar arkivet i xz-format.

Parameters:

ParameterTypBeskrivning
settingsXzArchiveSettingsuppsättning av specifika inställningar för xz-arkivet: ordboksstorlek, blockstorlek, kontrolltyp

XzArchive(InputStream source)

public XzArchive(InputStream source)

Initierar en ny instans av klassen XzArchive för dekomprimering.

Denna konstruktor dekomprimerar inte. Se metoden extract(java.io.OutputStream) för dekomprimering.

Parameters:

ParameterTypBeskrivning
sourcejava.io.InputStreamkällan till arkivet

XzArchive(InputStream source, XzLoadOptions options)

public XzArchive(InputStream source, XzLoadOptions options)

Initierar en ny instans av klassen XzArchive för dekomprimering.

Denna konstruktor dekomprimerar inte. Se metoden extract(java.io.OutputStream) för dekomprimering.

Parameters:

ParameterTypBeskrivning
sourcejava.io.InputStreamkällan till arkivet
optionsXzLoadOptionsAlternativ för att läsa in arkivet med.

XzArchive(String path)

public XzArchive(String path)

Initierar en ny instans av klassen XzArchive för dekomprimering.

Denna konstruktor dekomprimerar inte. Se metoden extract(java.io.OutputStream) för dekomprimering.

Parameters:

ParameterTypBeskrivning
pathjava.lang.Stringsökväg till arkivets källa

XzArchive(String path, XzLoadOptions options)

public XzArchive(String path, XzLoadOptions options)

Initierar en ny instans av klassen XzArchive för dekomprimering.

Denna konstruktor dekomprimerar inte. Se metoden extract(java.io.OutputStream) för dekomprimering.

Parameters:

ParameterTypBeskrivning
pathjava.lang.Stringsökväg till arkivets källa
optionsXzLoadOptions

close()

public void close()

extract(File file)

public final void extract(File file)

Extraherar xz-arkivet till en fil.

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




**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| file | java.io.File | file for storing decompressed data |

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

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



**Parameters:**
| Parameter | Typ | Beskrivning |
| --- | --- | --- |
| mål | java.io.OutputStream | ström för lagring av dekomprimerad data |

### extract(String path) {#extract-java.lang.String-}
```
public final File extract(String path)
```


Extraherar xz-arkivet till en fil via sökväg.

```

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




**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | path to 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 xz archive.

**Returns:**
java.lang.Iterable<com.aspose.zip.IArchiveFileEntry> - entries of [IArchiveFileEntry](../../com.aspose.zip/iarchivefileentry) type constituting the xz 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 the length of the entry in bytes.

**Returns:**
java.lang.Long - the length of the entry in bytes
### getName() {#getName--}

public final String getName()



Gets the name of the entry within archive.

**Returns:**
java.lang.String - the name of the entry within 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(OutputStream output) {#save-java.io.OutputStream-}

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:**
| Parameter | Typ | Beskrivning |
| --- | --- | --- |
| utdata | java.io.OutputStream | målström |

### save(String destinationFileName) {#save-java.lang.String-}
```
public final void save(String destinationFileName)
```


Sparar xz-arkivet till den angivna destinationsfilen.

```

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




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



**Parameters:**
| Parameter | Typ | Beskrivning |
| --- | --- | --- |
| file | java.io.File | fil, som kommer att öppnas som inmatningsström |

### setSource(InputStream source) {#setSource-java.io.InputStream-}
```
public final void setSource(InputStream source)
```


Ställer in innehållet som ska komprimeras i arkivet.

```

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




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



**Parameters:**
| Parameter | Typ | Beskrivning |
| --- | --- | --- |
| sourcePath | java.lang.String | sökväg till fil som kommer att öppnas som inmatningsström |