com.sage.accpac.sm
Enum Meter.State

java.lang.Object
  extended by java.lang.Enum<Meter.State>
      extended by com.sage.accpac.sm.Meter.State
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Meter.State>
Enclosing interface:
Meter

public static enum Meter.State
extends java.lang.Enum<Meter.State>

Enumeration of possible states


Enum Constant Summary
Canceled
          The state once the process has disconnected from the meter if the previous state was Canceling
Canceling
          The state once the process has been informed of the cancel request or the process decides to cancel of its own volition
Finished
          The state once the process has disconnected from the meter if the previous state was not Canceling
RequestCancel
          The state following a call to cancel before it is acknowledged or the meter is disconnected from the process
Running
          The initial state of a meter
 
Method Summary
static Meter.State valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Meter.State[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

Running

public static final Meter.State Running
The initial state of a meter


RequestCancel

public static final Meter.State RequestCancel
The state following a call to cancel before it is acknowledged or the meter is disconnected from the process


Canceling

public static final Meter.State Canceling
The state once the process has been informed of the cancel request or the process decides to cancel of its own volition


Canceled

public static final Meter.State Canceled
The state once the process has disconnected from the meter if the previous state was Canceling


Finished

public static final Meter.State Finished
The state once the process has disconnected from the meter if the previous state was not Canceling

Method Detail

values

public static Meter.State[] 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 (Meter.State c : Meter.State.values())
    System.out.println(c);

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

valueOf

public static Meter.State 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


Copyright © 2011 Sage Software, Inc. All rights reserved.