ipworkszip
Class OfficedocProgressEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--ipworkszip.OfficedocProgressEvent

All Implemented Interfaces:

java.io.Serializable

public class OfficedocProgressEvent

extends java.util.EventObject

Fired as progress is made.

The Progress event is automatically fired as compression or decompression is performed. When WriteToProgressEvent is true, the output data is provided through the Data parameter, allowing for it to be streamed out.

Filename contains the name of the file being written. If no file is being written, Filename will contain an empty string, and the output data will be provided exclusively through this event.

BytesProcessed contains the total number of uncompressed bytes processed. PercentProcessed contains the percent of uncompressed bytes processed, corresponding roughly to the running time of the operation.

For Gzip extraction only, BytesProcessed and PercentProcessed will reflect the number of compressed bytes extracted, as it is generally impossible to predetermine the total uncompressed size.

If WriteToProgressEvent is false, Data will contain null.

See Also:

Officedoc, Officedoc.ProgressEvent, Serialized Form

Field Summary

long	bytesProcessed
byte[]	data
java.lang.String	filename
int	percentProcessed

Fields inherited from class java.util.EventObject

source

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

data

public byte[] data

filename

public java.lang.String filename

bytesProcessed

public long bytesProcessed

percentProcessed

public int percentProcessed