|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.able.AbleState
The AbleState class provides a set of state definitions for ABLE beans and agents.
Field Summary | |
---|---|
static int |
Active
The object is active; it has been invoked. |
static int |
Initiated
The object has just been created. |
static int |
NumberOfStates
The total number of known states. |
static int |
Suspended
The object is currently suspended. |
static int |
Transit
The object is in transit. |
static int |
Uninitiated
The object's constructor has just completed. |
static int |
Unknown
The object is in an unknown state. |
static int |
Waiting
The object is currently waiting. |
Constructor Summary | |
---|---|
AbleState()
Create a new state and set it to the value Unknown . |
|
AbleState(int theInitialState)
Create a new state and set it to the specified value. |
Method Summary | |
---|---|
static java.lang.String |
Copyright()
Determine the copyright of this class. |
int |
getState()
Returns the current state. |
static boolean |
isReady(int state)
The isReady method examines the state value to determine if a bean is capable of processing data, whether by dataflow, synchronous or asynchronous event passing, or timed interval processing. |
void |
setState(int theNewState)
Set the current state to the specified value. |
static java.lang.String |
State(int theItem)
Returns the specified state as text for error messages. |
java.lang.String |
toString()
Retrieve a string describing (the contents of) the object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int Unknown
public static final int Uninitiated
public static final int Initiated
public static final int Active
public static final int Waiting
public static final int Suspended
public static final int Transit
public static final int NumberOfStates
Constructor Detail |
public AbleState()
Unknown
.public AbleState(int theInitialState)
theInitialState
- A valid AbleState value.
Method Detail |
public static final java.lang.String State(int theItem)
theItem
- A valid (or invalid) AbleState value.
public void setState(int theNewState)
theNewState
- A valid AbleState value. If an unknown value is
provided, an error message is logged, but the state
field is unchanged.public final int getState()
public static boolean isReady(int state)
true
if the state is Active
,
Initiated
, or Waiting
.public java.lang.String toString()
toString
in class java.lang.Object
public static java.lang.String Copyright()
|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |