com.gurock.smartinspect

Class ControlCommandType

java.lang.Object

com.gurock.smartinspect.ControlCommandType

public final class ControlCommandType
extends Object

Represents the type of a ControlCommand packet. The type of a Control Command influences the way the Console interprets the packet.

For example, if a Control Command packet has a type of ControlCommandType.ClearAll, the entire Console is reset when this packet arrives. Also have a look at the corresponding Session.clearAll method.

This class is fully threadsafe.

Field Summary

Fields

Modifier and Type	Field and Description
static ControlCommandType	ClearAll Instructs the Console to reset the whole Console.
static ControlCommandType	ClearAutoViews Instructs the Console to clear all AutoViews.
static ControlCommandType	ClearLog Instructs the Console to clear all Log Entries.
static ControlCommandType	ClearProcessFlow Instructs the Console to clear all Process Flow entries.
static ControlCommandType	ClearWatches Instructs the Console to clear all Watches.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Indicates whether some other object is equal to this one.
int	getIntValue() Returns the integer value of this enum.
boolean	greater(com.gurock.smartinspect.Enum en) Indicates whether the integer value of this Enum is greater than the integer value of some other Enum.
boolean	greaterEqual(com.gurock.smartinspect.Enum en) Indicates whether the integer value of this Enum is greater than or equal to the integer value of some other Enum.
boolean	less(com.gurock.smartinspect.Enum en) Indicates whether the integer value of this Enum is less than the integer value of some other Enum.
boolean	lessEqual(com.gurock.smartinspect.Enum en) Indicates whether the integer value of this Enum is less than or equal to the integer value of some other Enum.
String	toString() Overridden.

Methods inherited from class java.lang.Object

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

Field Detail

ClearLog

public static final ControlCommandType ClearLog

Instructs the Console to clear all Log Entries.

ClearWatches

public static final ControlCommandType ClearWatches

Instructs the Console to clear all Watches.

ClearAutoViews

public static final ControlCommandType ClearAutoViews

Instructs the Console to clear all AutoViews.

ClearAll

public static final ControlCommandType ClearAll

Instructs the Console to reset the whole Console.

ClearProcessFlow

public static final ControlCommandType ClearProcessFlow

Instructs the Console to clear all Process Flow entries.

Method Detail

toString

public String toString()

Overridden. Creates and returns a string representation of this object.

Overrides:

toString in class Object

Returns:

A string representation of this object. The return value is either the name of this Enum object if set or the integer value converted to a string.

getIntValue

public int getIntValue()

Returns the integer value of this enum.

Returns:

The integer value of this enum. For a string representation of this Enum object, refer to the documentation of the toString method.

equals

public boolean equals(Object o)

Indicates whether some other object is equal to this one.

This method returns true if the supplied Object is an Enum and has the same integer value as returned by the getIntValue() method of this object. If the supplied Object is not an Enum, this method calls the equals method of the parent class.

Overrides:

equals in class Object

Parameters:

o - The object to compare this enum with.

Returns:

True if the supplied object equals this enum and false otherwise.

less

public boolean less(com.gurock.smartinspect.Enum en)

Indicates whether the integer value of this Enum is less than the integer value of some other Enum.

Parameters:

en - The enum to compare this enum with.

Returns:

True if the integer value of this Enum is less than the integer value of the supplied Enum and false otherwise.

lessEqual

public boolean lessEqual(com.gurock.smartinspect.Enum en)

Indicates whether the integer value of this Enum is less than or equal to the integer value of some other Enum.

Parameters:

en - The enum to compare this enum with.

Returns:

True if the integer value of this Enum is less than or equal to the integer value of the supplied Enum and false otherwise.

greater

public boolean greater(com.gurock.smartinspect.Enum en)

Indicates whether the integer value of this Enum is greater than the integer value of some other Enum.

Parameters:

en - The enum to compare this enum with.

Returns:

True if the integer value of this Enum is greater than the integer value of the supplied Enum and false otherwise.

greaterEqual

public boolean greaterEqual(com.gurock.smartinspect.Enum en)

Indicates whether the integer value of this Enum is greater than or equal to the integer value of some other Enum.

Parameters:

en - The enum to compare this enum with.

Returns:

True if the integer value of this Enum is greater than or equal to the integer value of the supplied Enum and false otherwise.