OpenJDK 27 · javax.imageio.event.IIOWriteProgressListener

Method Summary

Modifier and Type	Method and Description
public void	imageComplete(ImageWriter the `ImageWriter` object calling this method. source) Reports that the image write operation has completed.
public void	imageProgress(ImageWriter the `ImageWriter` object calling this method. source, float the approximate percentage of decoding that has been completed. percentageDone) Reports the approximate degree of completion of the current `write` call within the associated `ImageWriter`.
public void	imageStarted(ImageWriter the `ImageWriter` object calling this method. source, int the index of the image being written within its containing input file or stream. imageIndex) Reports that an image write operation is beginning.
public void	thumbnailComplete(ImageWriter the `ImageWriter` object calling this method. source) Reports that a thumbnail write operation has completed.
public void	thumbnailProgress(ImageWriter the `ImageWriter` object calling this method. source, float the approximate percentage of decoding that has been completed. percentageDone) Reports the approximate degree of completion of the current thumbnail write within the associated `ImageWriter`.
public void	thumbnailStarted(ImageWriter the `ImageWrite` object calling this method. source, int the index of the image being written within its containing input file or stream. imageIndex, int the index of the thumbnail being written. thumbnailIndex) Reports that a thumbnail write operation is beginning.
public void	writeAborted(ImageWriter the `ImageWriter` object calling this method. source) Reports that a write has been aborted via the writer's `abort` method.

Method Detail

imageComplete back to summary

imageComplete	back to summary
public void imageComplete(ImageWriter source) Reports that the image write operation has completed. All `ImageWriter` implementations are required to call this method exactly once upon completion of each image write operation. Parameters source:ImageWriter the `ImageWriter` object calling this method.

public void imageComplete(ImageWriter source)

Reports that the image write operation has completed. All ImageWriter implementations are required to call this method exactly once upon completion of each image write operation.

Parameters

source:ImageWriter: the ImageWriter object calling this method.

imageProgress back to summary

imageProgress	back to summary
public void imageProgress(ImageWriter source, float percentageDone) Reports the approximate degree of completion of the current `write` call within the associated `ImageWriter`. The degree of completion is expressed as an index indicating which image is being written, and a percentage varying from `0.0F` to `100.0F` indicating 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 values `0` and `100`, as these may be inferred by the callee from other methods. Each particular `ImageWriter` implementation may call this method at whatever frequency it desires. A rule of thumb is to call it around each 5 percent mark. Parameters source:ImageWriter the `ImageWriter` object calling this method. percentageDone:float the approximate percentage of decoding that has been completed.

public void imageProgress(ImageWriter source, float percentageDone)

Reports the approximate degree of completion of the current write call within the associated ImageWriter.

The degree of completion is expressed as an index indicating which image is being written, and a percentage varying from 0.0F to 100.0F indicating 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 values 0 and 100, as these may be inferred by the callee from other methods.

Each particular ImageWriter implementation may call this method at whatever frequency it desires. A rule of thumb is to call it around each 5 percent mark.

Parameters

source:ImageWriter: the ImageWriter object calling this method.
percentageDone:float: the approximate percentage of decoding that has been completed.

imageStarted back to summary

imageStarted	back to summary
public void imageStarted(ImageWriter source, int imageIndex) Reports that an image write operation is beginning. All `ImageWriter` implementations are required to call this method exactly once when beginning an image write operation. Parameters source:ImageWriter the `ImageWriter` object calling this method. imageIndex:int the index of the image being written within its containing input file or stream.

public void imageStarted(ImageWriter source, int imageIndex)

Reports that an image write operation is beginning. All ImageWriter implementations are required to call this method exactly once when beginning an image write operation.

Parameters

source:ImageWriter: the ImageWriter object calling this method.
imageIndex:int: the index of the image being written within its containing input file or stream.

thumbnailComplete back to summary

thumbnailComplete	back to summary
public void thumbnailComplete(ImageWriter source) Reports that a thumbnail write operation has completed. All `ImageWriter` implementations are required to call this method exactly once upon completion of each thumbnail write operation. Parameters source:ImageWriter the `ImageWriter` object calling this method.

public void thumbnailComplete(ImageWriter source)

Reports that a thumbnail write operation has completed. All ImageWriter implementations are required to call this method exactly once upon completion of each thumbnail write operation.

Parameters

source:ImageWriter: the ImageWriter object calling this method.

thumbnailProgress back to summary

thumbnailProgress	back to summary
public void thumbnailProgress(ImageWriter source, float percentageDone) Reports the approximate degree of completion of the current thumbnail write within the associated `ImageWriter`. The semantics are identical to those of `imageProgress`. Parameters source:ImageWriter the `ImageWriter` object calling this method. percentageDone:float the approximate percentage of decoding that has been completed.

public void thumbnailProgress(ImageWriter source, float percentageDone)

Reports the approximate degree of completion of the current thumbnail write within the associated ImageWriter. The semantics are identical to those of imageProgress.

Parameters

source:ImageWriter: the ImageWriter object calling this method.
percentageDone:float: the approximate percentage of decoding that has been completed.

thumbnailStarted back to summary

thumbnailStarted	back to summary
public void thumbnailStarted(ImageWriter source, int imageIndex, int thumbnailIndex) Reports that a thumbnail write operation is beginning. All `ImageWriter` implementations are required to call this method exactly once when beginning a thumbnail write operation. Parameters source:ImageWriter the `ImageWrite` object calling this method. imageIndex:int the index of the image being written within its containing input file or stream. thumbnailIndex:int the index of the thumbnail being written.

public void thumbnailStarted(ImageWriter source, int imageIndex, int thumbnailIndex)

Reports that a thumbnail write operation is beginning. All ImageWriter implementations are required to call this method exactly once when beginning a thumbnail write operation.

Parameters

source:ImageWriter: the ImageWrite object calling this method.
imageIndex:int: the index of the image being written within its containing input file or stream.
thumbnailIndex:int: the index of the thumbnail being written.

writeAborted back to summary

writeAborted	back to summary
public void writeAborted(ImageWriter source) Reports that a write has been aborted via the writer's `abort` method. No further notifications will be given. Parameters source:ImageWriter the `ImageWriter` object calling this method.

public void writeAborted(ImageWriter source)

Reports that a write has been aborted via the writer's abort method. No further notifications will be given.

Parameters

source:ImageWriter: the ImageWriter object calling this method.

public Interface IIOWriteProgressListener

Method Summary

Method Detail