Interface IIOWriteProgressListener
- All Superinterfaces:
EventListener
ImageWriter implementations to notify
callers of their image writing methods of progress.- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoidimageComplete(ImageWriter source) Reports that the image write operation has completed.voidimageProgress(ImageWriter source, float percentageDone) Reports the approximate degree of completion of the currentwritecall within the associatedImageWriter.voidimageStarted(ImageWriter source, int imageIndex) Reports that an image write operation is beginning.voidthumbnailComplete(ImageWriter source) Reports that a thumbnail write operation has completed.voidthumbnailProgress(ImageWriter source, float percentageDone) Reports the approximate degree of completion of the current thumbnail write within the associatedImageWriter.voidthumbnailStarted(ImageWriter source, int imageIndex, int thumbnailIndex) Reports that a thumbnail write operation is beginning.voidwriteAborted(ImageWriter source) Reports that a write has been aborted via the writer'sabortmethod.
-
Method Details
-
imageStarted
Reports that an image write operation is beginning. AllImageWriterimplementations are required to call this method exactly once when beginning an image write operation.- Parameters:
source- theImageWriterobject calling this method.imageIndex- the index of the image being written within its containing input file or stream.
-
imageProgress
Reports the approximate degree of completion of the currentwritecall within the associatedImageWriter.The degree of completion is expressed as an index indicating which image is being written, and a percentage varying from
0.0Fto100.0Findicating how much of the current image has been output. The percentage should ideally be calculated in terms of the remaining time to completion, but it is usually more practical to use a more well-defined metric such as pixels decoded or portion of input stream consumed. In any case, a sequence of calls to this method during a given read operation should supply a monotonically increasing sequence of percentage values. It is not necessary to supply the exact values0and100, as these may be inferred by the callee from other methods.Each particular
ImageWriterimplementation may call this method at whatever frequency it desires. A rule of thumb is to call it around each 5 percent mark.- Parameters:
source- theImageWriterobject calling this method.percentageDone- the approximate percentage of decoding that has been completed.
-
imageComplete
Reports that the image write operation has completed. AllImageWriterimplementations are required to call this method exactly once upon completion of each image write operation.- Parameters:
source- theImageWriterobject calling this method.
-
thumbnailStarted
Reports that a thumbnail write operation is beginning. AllImageWriterimplementations are required to call this method exactly once when beginning a thumbnail write operation.- Parameters:
source- theImageWriteobject calling this method.imageIndex- the index of the image being written within its containing input file or stream.thumbnailIndex- the index of the thumbnail being written.
-
thumbnailProgress
Reports the approximate degree of completion of the current thumbnail write within the associatedImageWriter. The semantics are identical to those ofimageProgress.- Parameters:
source- theImageWriterobject calling this method.percentageDone- the approximate percentage of decoding that has been completed.
-
thumbnailComplete
Reports that a thumbnail write operation has completed. AllImageWriterimplementations are required to call this method exactly once upon completion of each thumbnail write operation.- Parameters:
source- theImageWriterobject calling this method.
-
writeAborted
Reports that a write has been aborted via the writer'sabortmethod. No further notifications will be given.- Parameters:
source- theImageWriterobject calling this method.
-