mil.nga.geopackage.io.GeoPackageProgress Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geopackage-core Show documentation

Core functionality for GeoPackage implementations

There is a newer version: 6.6.7

package mil.nga.geopackage.io;

/**
 * GeoPackage Progress interface for receiving progress information and handling
 * cancellations
 * 
 * @author osbornb
 */
public interface GeoPackageProgress {

	/**
	 * Set the max progress value
	 * 
	 * @param max
	 */
	public void setMax(int max);

	/**
	 * Add to the total progress
	 * 
	 * @param progress
	 */
	public void addProgress(int progress);

	/**
	 * Is the process still active
	 * 
	 * @return true if active, false if cancelled
	 */
	public boolean isActive();

	/**
	 * Should the progress so far be deleted when cancelled ({@link #isActive()}
	 * becomes false)
	 * 
	 * @return true to cleanup progress
	 */
	public boolean cleanupOnCancel();

}