com.kapowtech.robosuite.api.java.rql.construct

Class ExecutionStatus

java.lang.Object

com.kapowtech.robosuite.api.java.rql.construct.ExecutionStatus

All Implemented Interfaces:

java.io.Serializable

public final class ExecutionStatus
extends java.lang.Object
implements java.io.Serializable

Typesafe enumeration representing an execution status.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ExecutionStatus	COMPLETED The robot has completed executing.
static ExecutionStatus	PENDING The request request has been received, and that the robot is pending execution.
static ExecutionStatus	RUNNING Signals that the robot is currently executing.
static java.util.List	STATUS_OBJECTS A list of all the supported ExecutionStatus types.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one.
java.lang.String	getDescription() Returns a short description of the execution status.
int	getStatusCode() Returns the status code for this execution status.
int	hashCode() Returns a hash code value for the object.
static ExecutionStatus	parseExecutionStatus(int statusCode) Returns the ExecutionStatus corresponding to a given status code.
static ExecutionStatus	parseExecutionStatus(java.lang.String statusDescription) Returns the ExecutionStatus corresponding to a given event description.
java.lang.Object	readResolve() Resolves this object correctly when serializing.
java.lang.String	toString() Returns a human readable string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PENDING

public static final ExecutionStatus PENDING

The request request has been received, and that the robot is pending execution.

RUNNING

public static final ExecutionStatus RUNNING

Signals that the robot is currently executing.

COMPLETED

public static final ExecutionStatus COMPLETED

The robot has completed executing.

STATUS_OBJECTS

public static final java.util.List STATUS_OBJECTS

A list of all the supported ExecutionStatus types.

Method Detail

parseExecutionStatus

public static ExecutionStatus parseExecutionStatus(int statusCode)

Returns the ExecutionStatus corresponding to a given status code.

Parameters:

statusCode - the status code to parse. It must be in the range 0-3 to be accepted.

Returns:

the ExecutionStatus corresponding to a given status code.

Throws:

java.lang.IllegalArgumentException - if the statusCode did not correspond to a valid ExecutionStatus.

See Also:

getStatusCode

parseExecutionStatus

public static ExecutionStatus parseExecutionStatus(java.lang.String statusDescription)

Returns the ExecutionStatus corresponding to a given event description. The lookup is not case sensitive. The strings "pending" or "Pending" will both return the same object, ExecutionStatus.PENDING.

Parameters:

statusDescription - an event description string. It must correspond to a description that can be returned by a valid ExecutionStatus. The lookup is not case sensitive.

Returns:

the ExecutionStatus corresponding to a given status description.

Throws:

java.lang.IllegalArgumentException - if the statusDescription did not correspond to a valid ExecutionStatus.

See Also:

getDescription, toString

equals

public boolean equals(java.lang.Object obj)

Indicates whether some other object is "equal to" this one.

Testing on object identity should generally be acceptable, because this is a typesafe enumeration. However, that cannot be guaranteed to always hold true, when comparing objects instantiated by different classloaders. This method therefore test on the statusCode property.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

hashCode

public int hashCode()

Returns a hash code value for the object. The hash code is identical to the statuscode.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

getDescription

public java.lang.String getDescription()

Returns a short description of the execution status.

Returns:

a short description of the execution status.

getStatusCode

public int getStatusCode()

Returns the status code for this execution status.

Returns:

the status code for this execution status

toString

public java.lang.String toString()

Returns a human readable string representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

a human readable string representation of this object.

readResolve

public java.lang.Object readResolve()
                             throws java.io.ObjectStreamException

Resolves this object correctly when serializing.

Returns:

an ExecutionStatus object.

Throws:

java.io.ObjectStreamException - if the stream cannot be deserialized

java.io.InvalidObjectException - if this implementation did not support the given status code.