com.sonicsw.mf.common.runtime
Interface IState

All Superinterfaces:

java.lang.Comparable

All Known Subinterfaces:

IChildContainerState, IComponentState, IContainerState

public interface IState
extends java.lang.Comparable

A base interface for interfaces that describe container or component runtime state.

See Also:

IContainerState, IComponentState

Method Summary

int	compareTo(java.lang.Object object) Compares this object with the specified object for order.
boolean	equals(java.lang.Object object) Tests if the given object is equal to this identity.
IIdentity	getRuntimeIdentity() Get the runtime identity of the source of the state.
short	getState() Get the runtime state value.
java.lang.String	getStateString() Get a textual description for the runtime state value.

Method Detail

compareTo

int compareTo(java.lang.Object object)
              throws java.lang.ClassCastException

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Comparison is made using the toString() value.

Specified by:

compareTo in interface java.lang.Comparable

Throws:

java.lang.ClassCastException - If the given object is not an instance of the same object.

equals

boolean equals(java.lang.Object object)

Tests if the given object is equal to this identity.

Overrides:

equals in class java.lang.Object

Returns:

Returns true if the runtime identity of this state and its state equals that of the given object.

getRuntimeIdentity

IIdentity getRuntimeIdentity()

Get the runtime identity of the source of the state.

getState

short getState()

Get the runtime state value.

Returns:

Return either a container or component runtime state value. Possible values are described in their respective interfaces ("STATE_<>" members).

See Also:

IContainerState, IComponentState

getStateString

java.lang.String getStateString()

Get a textual description for the runtime state value.

See Also:

IContainerState, IComponentState