WimArchive

Inheritance: java.lang.Object

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

public class WimArchive implements IArchive, AutoCloseable

This class represents a wim archive file.

Constructors

Constructor	Description
WimArchive(InputStream sourceStream)	Initializes a new instance of the WimArchive class and composes an entry list can be extracted from the archive.
WimArchive(InputStream sourceStream, WimLoadOptions loadOptions)	Initializes a new instance of the WimArchive class and composes an entry list can be extracted from the archive.
WimArchive(String path)	Initializes a new instance of the WimArchive class and composes an entry list can be extracted from the archive.
WimArchive(String path, WimLoadOptions loadOptions)	Initializes a new instance of the WimArchive class and composes an entry list can be extracted from the archive.

Methods

Method	Description
close()	{@inheritDoc}
extractToDirectory(String destinationDirectory)	Extracts the archive to the file by path.
getBootImageIndex()	Gets the (zero-based) index of the bootable image.
getEntries()	Gets entries of WimEntry type constituting the archive.
getFileEntries()	Gets entries of IArchiveFileEntry type constituting the wim archive.
getFileFormatVersion()	Gets the version of the file format.
getFormat()	Gets the archive format.
getGuid()	Gets the identifying UUID for the archive.
getImages()	Gets entries of WimImage type constituting the archive.
getManifest()	Gets the embedded manifest describing the file and the contained images.

WimArchive(InputStream sourceStream)

public WimArchive(InputStream sourceStream)

Initializes a new instance of the WimArchive class and composes an entry list can be extracted from the archive.

The following example shows how to extract all of the entries to a directory.

 try (WimArchive archive = new WimArchive(new FileInputStream("archive.wim"))) {
     archive.getImages().get_Item(0).extractToDirectory("C:\\extracted");
 } catch (IOException ex) {
 }


This constructor does not unpack any entry. See [WimFileEntry.open()](../../com.aspose.zip/wimfileentry\#open--) method for unpacking.

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

### WimArchive(InputStream sourceStream, WimLoadOptions loadOptions) {#WimArchive-java.io.InputStream-com.aspose.zip.WimLoadOptions-}

public WimArchive(InputStream sourceStream, WimLoadOptions loadOptions)



Initializes a new instance of the [WimArchive](../../com.aspose.zip/wimarchive) class and composes an entry list can be extracted from the archive.

The following example shows how to extract all of the entries to a directory.


     try (WimArchive archive = new WimArchive(new FileInputStream("archive.wim"))) {
         archive.getImages().get_Item(0).extractToDirectory("C:\\extracted");
     } catch (IOException ex) {
     }
 
```

This constructor does not unpack any entry. See [WimFileEntry.open()](../../com.aspose.zip/wimfileentry\#open--) method for unpacking.

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

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


Initializes a new instance of the [WimArchive](../../com.aspose.zip/wimarchive) class and composes an entry list can be extracted from the archive.

The following example shows how to extract all of the entries to a directory.

```

 try (WimArchive archive = new WimArchive("archive.wim")) {
     archive.getImages().get_Item(0).extractToDirectory("C:\\extracted");
 }


This constructor does not unpack any entry. See [WimFileEntry.open()](../../com.aspose.zip/wimfileentry\#open--) method for unpacking.

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

### WimArchive(String path, WimLoadOptions loadOptions) {#WimArchive-java.lang.String-com.aspose.zip.WimLoadOptions-}

public WimArchive(String path, WimLoadOptions loadOptions)



Initializes a new instance of the [WimArchive](../../com.aspose.zip/wimarchive) class and composes an entry list can be extracted from the archive.

The following example shows how to extract all of the entries to a directory.


     try (WimArchive archive = new WimArchive("archive.wim")) {
         archive.getImages().get_Item(0).extractToDirectory("C:\\extracted");
     }
 
```

This constructor does not unpack any entry. See [WimFileEntry.open()](../../com.aspose.zip/wimfileentry\#open--) method for unpacking.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| path | java.lang.String | the path to the archive file |
| loadOptions | [WimLoadOptions](../../com.aspose.zip/wimloadoptions) | Options to load existing archive with. |

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




### extractToDirectory(String destinationDirectory) {#extractToDirectory-java.lang.String-}
```
public final void extractToDirectory(String destinationDirectory)
```


Extracts the archive to the file by path.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| destinationDirectory | java.lang.String | the path to the directory to place the extracted files in |

### getBootImageIndex() {#getBootImageIndex--}
```
public final int getBootImageIndex()
```


Gets the (zero-based) index of the bootable image.

**Returns:**
int - the (zero-based) index of the bootable image
### getEntries() {#getEntries--}
```
public final List<WimEntry> getEntries()
```


Gets entries of [WimEntry](../../com.aspose.zip/wimentry) type constituting the archive.

**Returns:**
java.util.List&lt;com.aspose.zip.WimEntry&gt; - entries constituting the archive
### getFileEntries() {#getFileEntries--}
```
public final Iterable<IArchiveFileEntry> getFileEntries()
```


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

**Returns:**
java.lang.Iterable&lt;com.aspose.zip.IArchiveFileEntry&gt; - entries of [IArchiveFileEntry](../../com.aspose.zip/iarchivefileentry) type constituting the wim archive
### getFileFormatVersion() {#getFileFormatVersion--}
```
public final int getFileFormatVersion()
```


Gets the version of the file format.

**Returns:**
int - the version of the file format
### getFormat() {#getFormat--}
```
public final ArchiveFormat getFormat()
```


Gets the archive format.

**Returns:**
[ArchiveFormat](../../com.aspose.zip/archiveformat) - the archive format
### getGuid() {#getGuid--}
```
public final UUID getGuid()
```


Gets the identifying UUID for the archive.

**Returns:**
java.util.UUID - the identifying UUID for the archive
### getImages() {#getImages--}
```
public final List<WimImage> getImages()
```


Gets entries of [WimImage](../../com.aspose.zip/wimimage) type constituting the archive.

**Returns:**
java.util.List&lt;com.aspose.zip.WimImage&gt; - entries of [WimImage](../../com.aspose.zip/wimimage) type constituting the archive
### getManifest() {#getManifest--}
```
public final String getManifest()
```


Gets the embedded manifest describing the file and the contained images.

**Returns:**
java.lang.String - the embedded manifest describing the file and the contained images

UueSaveOptions WimDirectoryEntry