net.charlesames.utility.common
Enum ProgressMonitor.Status

java.lang.Object
  java.lang.Enum<ProgressMonitor.Status>
      net.charlesames.utility.common.ProgressMonitor.Status

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ProgressMonitor.Status>

Enclosing class:

ProgressMonitor

public static enum ProgressMonitor.Status
extends java.lang.Enum<ProgressMonitor.Status>

ProgressMonitor status conditions.

Author:

Charles Ames

Enum Constant Summary

CANCELED
A running process has detected that ProgressMonitor.isPermitted() return false, has shut down its activity, and has acknowledged this by calling ProgressMonitor.cancel().

COMPLETE
Process has completed successfully.

ERROR
Process has completed with an error.

INITIALIZING
Process is initializing.

KILLED
End user has requested the process to shut down immediately.

RUNNING
Process is running.

Method Summary

static ProgressMonitor.Status	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ProgressMonitor.Status[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INITIALIZING

public static final ProgressMonitor.Status INITIALIZING

Process is initializing. This is the default status when a ProgressMonitor is first constructed.

RUNNING

public static final ProgressMonitor.Status RUNNING

Process is running.

COMPLETE

public static final ProgressMonitor.Status COMPLETE

Process has completed successfully.

KILLED

public static final ProgressMonitor.Status KILLED

End user has requested the process to shut down immediately.

CANCELED

public static final ProgressMonitor.Status CANCELED

A running process has detected that ProgressMonitor.isPermitted() return false, has shut down its activity, and has acknowledged this by calling ProgressMonitor.cancel().

ERROR

public static final ProgressMonitor.Status ERROR

Process has completed with an error. Call getErrorMessage() for error details.

Method Detail

values

public static ProgressMonitor.Status[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ProgressMonitor.Status c : ProgressMonitor.Status.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ProgressMonitor.Status valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null