org.xnap.util
Class State

java.lang.Object
  extended by org.xnap.util.State

public class State
extends java.lang.Object

Represents a state of a FiniteStateMachine.


Field Summary
static State ABORTED
          Operation has been aborted.
static State ABORTING
          An abort is in progress.
static State CONNECTED
          Connect was successful.
static State CONNECTING
          Connect is in progress.
static State DELETED
          Object was deleted.
static State DISCONNECTED
          Disconnect was successful.
static State DISCONNECTING
          Disconnect is in progress.
static State DOWNLOADING
          Download in progress.
static State ERROR
          An unrecoverable error has occured.
static State FAILED
          Operation has failed.
static State FINISHED
          Operation is finished.
static State LOCALLY_QUEUED
          Object has been locally queued.
static State NOT_STARTED
          Operation has not started, yet.
static State REQUESTING
          Object has requested an operation.
static State RUNNING
          Something is going on.
static State SEARCHING
          Search is in progress.
static State STOPPED
          Operation has been stopped.
static State STOPPING
          A stop operation is in progress .
static State SUCCEEDED
          Operation was successful.
static State UPLOADING
          Upload in progress.
static State WAITING
          Waiting for something.
 
Constructor Summary
State()
           
State(java.lang.String description)
           
 
Method Summary
 java.lang.String getDescription()
          Returns a short description for this state.
 void setDescription(java.lang.String newValue)
          Sets a new description.
 java.lang.String toString()
          Returns getDescription().
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ABORTED

public static final State ABORTED
Operation has been aborted.


ABORTING

public static final State ABORTING
An abort is in progress.


CONNECTING

public static final State CONNECTING
Connect is in progress.


CONNECTED

public static final State CONNECTED
Connect was successful.


DELETED

public static final State DELETED
Object was deleted.


DISCONNECTING

public static final State DISCONNECTING
Disconnect is in progress.


DISCONNECTED

public static final State DISCONNECTED
Disconnect was successful.


DOWNLOADING

public static final State DOWNLOADING
Download in progress.


ERROR

public static final State ERROR
An unrecoverable error has occured.


FAILED

public static final State FAILED
Operation has failed.


FINISHED

public static final State FINISHED
Operation is finished.


LOCALLY_QUEUED

public static final State LOCALLY_QUEUED
Object has been locally queued.


NOT_STARTED

public static final State NOT_STARTED
Operation has not started, yet.


REQUESTING

public static final State REQUESTING
Object has requested an operation.


RUNNING

public static final State RUNNING
Something is going on.


SEARCHING

public static final State SEARCHING
Search is in progress.


STOPPING

public static final State STOPPING
A stop operation is in progress .


STOPPED

public static final State STOPPED
Operation has been stopped.


SUCCEEDED

public static final State SUCCEEDED
Operation was successful.


UPLOADING

public static final State UPLOADING
Upload in progress.


WAITING

public static final State WAITING
Waiting for something.

Constructor Detail

State

public State(java.lang.String description)

State

public State()
Method Detail

getDescription

public java.lang.String getDescription()
Returns a short description for this state. Usually used to inform the user.


setDescription

public void setDescription(java.lang.String newValue)
Sets a new description.


toString

public java.lang.String toString()
Returns getDescription().

Overrides:
toString in class java.lang.Object


Copyright © 2001-2005 XNap Team. All Rights Reserved.