hla.rti
Class ResignAction

java.lang.Object
  extended byhla.rti.ResignAction
All Implemented Interfaces:
java.io.Serializable

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

Represents a type of resignation action.

Author:
DMSO
See Also:
Serialized Form

Field Summary
static ResignAction CANCEL_PENDING_OWNERSHIP_ACQUISITIONS
          Upon resignation, cancel pending ownership acquisitions.
static ResignAction CANCEL_THEN_DELETE_THEN_DIVEST
          Upon resignation, cancel pending ownership acquisitions, delete objects, and divest attributes.
static ResignAction DELETE_OBJECTS
          Upon resignation, delete objects.
static ResignAction DELETE_OBJECTS_THEN_DIVEST
          Upon resignation, delete objects and then divest attributes.
static ResignAction NO_ACTION
          Take no action upon resignation.
static ResignAction UNCONDITIONALLY_DIVEST_ATTRIBUTES
          Upon resignation, divest attributes unconditionally.
private  int value
          The value of the instance.
 
Constructor Summary
private ResignAction(int pValue)
          Private constructor.
  ResignAction(ResignAction otherResignAction)
          Copy constructor.
 
Method Summary
 boolean equals(java.lang.Object otherResignAction)
          Compares this resignation action for equality with another.
 int hashCode()
          Computes and returns a hash code corresponding to this resignation action.
 java.lang.String toString()
          Returns a string representation of this resignation action.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

UNCONDITIONALLY_DIVEST_ATTRIBUTES

public static final ResignAction UNCONDITIONALLY_DIVEST_ATTRIBUTES
Upon resignation, divest attributes unconditionally.


DELETE_OBJECTS

public static final ResignAction DELETE_OBJECTS
Upon resignation, delete objects.


CANCEL_PENDING_OWNERSHIP_ACQUISITIONS

public static final ResignAction CANCEL_PENDING_OWNERSHIP_ACQUISITIONS
Upon resignation, cancel pending ownership acquisitions.


DELETE_OBJECTS_THEN_DIVEST

public static final ResignAction DELETE_OBJECTS_THEN_DIVEST
Upon resignation, delete objects and then divest attributes.


CANCEL_THEN_DELETE_THEN_DIVEST

public static final ResignAction CANCEL_THEN_DELETE_THEN_DIVEST
Upon resignation, cancel pending ownership acquisitions, delete objects, and divest attributes.


NO_ACTION

public static final ResignAction NO_ACTION
Take no action upon resignation.


value

private int value
The value of the instance.

Constructor Detail

ResignAction

public ResignAction(ResignAction otherResignAction)
Copy constructor.

Parameters:
otherResignAction - the resignation action object to copy

ResignAction

private ResignAction(int pValue)
Private constructor.

Parameters:
pValue - the integer value corresponding to this resignation action
Method Detail

equals

public boolean equals(java.lang.Object otherResignAction)
Compares this resignation action for equality with another.

Parameters:
otherResignAction - the other resignation action
Returns:
true if the two resignation actions are equal, false otherwise

hashCode

public int hashCode()
Computes and returns a hash code corresponding to this resignation action.

Returns:
a hash code corresponding to this resignation action

toString

public java.lang.String toString()
Returns a string representation of this resignation action.

Returns:
a string representation of this resignation action