Package org.gdal.gnm

Class ProgressCallback

  • Direct Known Subclasses:
    TermProgressCallback
    public class ProgressCallback
extends java.lang.Object
    Class used to report progression of long operations.

    This class will not do anything by itself, but it can be subclassed, like TermProgressCallback class. to do more useful things.

    Since:
    Java bindings 1.7.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void delete()  
      int run​(double dfComplete, java.lang.String message)
      Callback method called from long processing from GDAL methods.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ProgressCallback

        public ProgressCallback()

    • Method Detail

      • delete

        public void delete()

      • run

        public int run​(double dfComplete,
               java.lang.String message)
        Callback method called from long processing from GDAL methods.

        This method is called back with the progression percentage. Its return value is used by the caller to determine whether the processing should go on or be interrupted.

        This method should be subclassed by classes subclassing ProgressCallback.

        Parameters:
        dfComplete - progression percentage between 0 and 1
        message - processing message, may be null
        Returns:
        0 if you want to interrupt the processing, any value different from 0 to go on
        Since:
        Java bindings 1.7.0