Bzip2LoadOptions

Inheritance: java.lang.Object

public class Bzip2LoadOptions

Options for loading Bzip2Archive. Contains event raised on extraction.

Constructors

Constructor	Description
Bzip2LoadOptions()

Methods

Method	Description
getExtractionProgressed()	Gets an event that is raised when some bytes have been extracted.
setCancellationFlag(CancellationFlag value)	Sets a cancellation flag used to cancel the extraction operation.
setExtractionProgressed(Event<ProgressEventArgs> value)	Sets an event that is raised when some bytes have been extracted.

Bzip2LoadOptions()

public Bzip2LoadOptions()

getExtractionProgressed()

public Event<ProgressEventArgs> getExtractionProgressed()

Gets an event that is raised when some bytes have been extracted.

 int[] percent = { 0 };
 long originalFileLength = 10_000_000;

 Bzip2LoadOptions loadOptions = new Bzip2LoadOptions();
 loadOptions.setExtractionProgressed((sender, args) -> {
     percent[0] = (int)((100 * (double)args.getProceededBytes()) / originalFileLength);
 });


Event sender is the [Bzip2Archive](../../com.aspose.zip/bzip2archive) instance which extraction is progressed. The `ProgressEventArgs.getProceededBytes()`([ProgressEventArgs.getProceededBytes()](../../com.aspose.zip/progresseventargs\#getProceededBytes--)) is the number of bytes after extraction.

**Returns:**
[Event](../../com.aspose.zip/event) - an event that is raised when some bytes have been extracted
### setCancellationFlag(CancellationFlag value) {#setCancellationFlag-com.aspose.zip.CancellationFlag-}

public void setCancellationFlag(CancellationFlag value)



Sets a cancellation flag used to cancel the extraction operation.

Cancel Bzip2 archive extraction after a certain time.


     try (CancellationFlag cf = new CancellationFlag()) {
         cf.cancelAfter(TimeUnit.SECONDS.toMillis(60));
         Bzip2LoadOptions options = new Bzip2LoadOptions();
         options.setCancellationFlag(cf);
         try (Bzip2Archive a = new Bzip2Archive("big.bz2", options)) {
             try {
                 a.extract("data.bin");
             } catch (OperationCanceledException e) {
                 System.out.println("Extraction was cancelled after 60 seconds");
             }
         }
     }
 
```

Cancellation mostly results in some data not being extracted.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [CancellationFlag](../../com.aspose.zip/cancellationflag) | a cancellation flag used to cancel the extraction operation. |

### setExtractionProgressed(Event&lt;ProgressEventArgs&gt; value) {#setExtractionProgressed-com.aspose.zip.Event-com.aspose.zip.ProgressEventArgs--}
```
public void setExtractionProgressed(Event<ProgressEventArgs> value)
```


Sets an event that is raised when some bytes have been extracted.

```

 int[] percent = { 0 };
 long originalFileLength = 10_000_000;

 Bzip2LoadOptions loadOptions = new Bzip2LoadOptions();
 loadOptions.setExtractionProgressed((sender, args) -> {
     percent[0] = (int)((100 * (double)args.getProceededBytes()) / originalFileLength);
 });


Event sender is the [Bzip2Archive](../../com.aspose.zip/bzip2archive) instance which extraction is progressed. The `ProgressEventArgs.getProceededBytes()`([ProgressEventArgs.getProceededBytes()](../../com.aspose.zip/progresseventargs\#getProceededBytes--)) is the number of bytes after extraction.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | com.aspose.zip.Event&lt;com.aspose.zip.ProgressEventArgs&gt; | an event that is raised when some bytes have been extracted |

Bzip2CompressionSettings Bzip2SaveOptions