Sha256: 465e5a949583b2b6d7b2a6c3db2674ba3dd333042af5f9db8f0507f940f22e93
Contents?: true
Size: 1.57 KB
Versions: 6
Compression:
Stored size: 1.57 KB
Contents
package org.sunflow.system;
import org.sunflow.system.UI.Module;
import org.sunflow.system.UI.PrintLevel;
public interface UserInterface {
/**
* Displays some information to the user from the specified module with the
* specified print level. A user interface is free to show or ignore any
* message. Level filtering is done in the core and shouldn't be
* re-implemented by the user interface. All messages will be short enough
* to fit on one line.
*
* @param m module the message came from
* @param level seriousness of the message
* @param s string to display
*/
void print(Module m, PrintLevel level, String s);
/**
* Prepare a progress bar representing a lengthy task. The actual progress
* is first shown by the call to update and closed when update is closed
* with the max value. It is currently not possible to nest calls to
* setTask, so only one task needs to be tracked at a time.
*
* @param s desriptive string
* @param min minimum value of the task
* @param max maximum value of the task
*/
void taskStart(String s, int min, int max);
/**
* Updates the current progress bar to a value between the current min and
* max. When min or max are passed the progressed bar is shown or hidden
* respectively.
*
* @param current current value of the task in progress.
*/
void taskUpdate(int current);
/**
* Closes the current progress bar to indicate the task is over
*/
void taskStop();
}
Version data entries
6 entries across 6 versions & 1 rubygems