com.gurock.smartinspect

Class Level

java.lang.Object

com.gurock.smartinspect.Level

public class Level
extends Object

Represents the log level in the SmartInspect Java library. Please see the SmartInspect.setLevel and SmartInspect.setDefaultLevel methods for detailed examples and more information on how to use the Level enum.

Field Summary

Fields

Modifier and Type	Field and Description
static Level	Control This log level represents a special log level which is only used by the ControlCommand class and is not intended to be used directly.
static Level	Debug Represents the Debug log level.
static Level	Error Represents the Error log level.
static Level	Fatal Represents the Fatal log level.
static Level	Message Represents the Message log level.
static Level	Verbose Represents the Verbose log level.
static Level	Warning Represents the Warning log level.

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

Debug

public static final Level Debug

Represents the Debug log level. This log level is mostly intended to be used in the debug and development process.

Verbose

public static final Level Verbose

Represents the Verbose log level. This log level is intended to track the general progress of applications at a fine-grained level.

Message

public static final Level Message

Represents the Message log level. This log level is intended to track the general progress of applications at a coarse-grained level.

Warning

public static final Level Warning

Represents the Warning log level. This log level designates potentially harmful events or situations.

Error

public static final Level Error

Represents the Error log level. This log level designates error events or situations which are not critical to the entire system. This log level thus describes recoverable or less important errors.

Fatal

public static final Level Fatal

Represents the Fatal log level. This log level designates errors which are not recoverable and eventually stop the system or application from working.

Control

public static final Level Control

This log level represents a special log level which is only used by the ControlCommand class and is not intended to be used directly.

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.