Changeset 4364 for trunk/gli/src/org/greenstone/gatherer/shell/GShellProgressMonitor.java

Timestamp:

2003-05-27T15:40:47+12:00 (21 years ago)

Author:

mdewsnip

Message:

Fixed tabbing.

File:

• trunk/gli/src/org/greenstone/gatherer/shell/GShellProgressMonitor.java (modified) (1 diff)

trunk/gli/src/org/greenstone/gatherer/shell/GShellProgressMonitor.java

@@ -58 +58 @@
  */
 public interface GShellProgressMonitor {
-     /** Method to register a new progress bar with this monitor.
-      * @param progress_bar The new <strong>JProgressBar</strong>.
-      */
-     public void addProgressBar(JProgressBar progress_bar);
-     /** Determine the script exit value according to the progress monitor. This gets around a problem where several script failures actually result with a successful exit value.
-      * @return A <i>int</i> with a value of zero if and only if the script was successful.
-      */
-     public int exitValue();
-     /** Method to retrieve whatever control is being used as the progress indicator. Usually a <strong>JProgressBar</strong> but there may be others implemented later.
-      * @return A <strong>Component</strong> on which the progress of the process is being displayed.
-      */
-     public Component getProgress();
-     /** Method to determine the state of the stop flag, which may be set by the visual component that created this monitor.
-      * @return A <strong>boolean</strong> indicating if the process has been asked to stop.
-      */
-     public boolean hasSignalledStop();
-     /** Inform the progress bar that it should programatically increment progress by one step. */
-     public void increment();
-     /** This method is used to 'feed in' a line of text captured from the process.
-      * @param line A <strong>String</strong> of text captured from either standard out or standard error.
-      */
-     public void parse(String line);
-     /** Since the creator of this process monitor is actually in the GUI, this class provides the simpliest way to send a cancel process message between the two.
-      * @param state The desired state of the stop flag as a <strong>boolean</strong>.
-      */
-     public void setStop(boolean state);
-     /** This method resets this monitor to the start, reseting the process parsing and progress bar.
-      */
-     public void start();
-     /** This method indicates the process is complete. 
-      */
-     public void stop();
+    /** Method to register a new progress bar with this monitor.
+     * @param progress_bar The new <strong>JProgressBar</strong>.
+     */
+    public void addProgressBar(JProgressBar progress_bar);
+    /** Determine the script exit value according to the progress monitor. This gets around a problem where several script failures actually result with a successful exit value.
+     * @return A <i>int</i> with a value of zero if and only if the script was successful.
+     */
+    public int exitValue();
+    /** Method to retrieve whatever control is being used as the progress indicator. Usually a <strong>JProgressBar</strong> but there may be others implemented later.
+     * @return A <strong>Component</strong> on which the progress of the process is being displayed.
+     */
+    public Component getProgress();
+    /** Method to determine the state of the stop flag, which may be set by the visual component that created this monitor.
+     * @return A <strong>boolean</strong> indicating if the process has been asked to stop.
+     */
+    public boolean hasSignalledStop();
+    /** Inform the progress bar that it should programatically increment progress by one step. */
+    public void increment();
+    /** This method is used to 'feed in' a line of text captured from the process.
+     * @param line A <strong>String</strong> of text captured from either standard out or standard error.
+     */
+    public void parse(String line);
+    /** Since the creator of this process monitor is actually in the GUI, this class provides the simpliest way to send a cancel process message between the two.
+     * @param state The desired state of the stop flag as a <strong>boolean</strong>.
+     */
+    public void setStop(boolean state);
+    /** This method resets this monitor to the start, reseting the process parsing and progress bar.
+     */
+    public void start();
+    /** This method indicates the process is complete. 
+     */
+    public void stop();
 }
-