com.aquenos.epics.jackie.common.protocol

Class ChannelAccessStatus.StatusSeverity

java.lang.Object

com.aquenos.epics.jackie.common.protocol.ChannelAccessStatus.StatusSeverity

Enclosing class:

ChannelAccessStatus

public static class ChannelAccessStatus.StatusSeverity
extends java.lang.Object

Severity for status codes. The severity indicates to which category a status code belongs and whether it represents a severe problem.

Author:

Sebastian Marsching

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Tells whether the specified object represents the same severity.
ChannelAccessStatus.StatusSeverityLevel	getLevel() Returns the level of this severity.
int	hashCode() Returns a hash code value for this severity.
boolean	isSevere() Returns true if this severity indicates a severe problem.
java.lang.String	toString() Returns a string representation of this severity.

Methods inherited from class java.lang.Object

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

Method Detail

getLevel

public ChannelAccessStatus.StatusSeverityLevel getLevel()

Returns the level of this severity. The level defines to which category a message belongs: success indicator, informational message, warning or error.

Returns:

level associated with this severity.

isSevere

public boolean isSevere()

Returns true if this severity indicates a severe problem. Usually, the severe flag is only used in combination with the ChannelAccessStatus.StatusSeverityLevel.ERROR level and is reserved for problems that indicate an unexpected problem in the server.

Returns:

flag indicating a severe problem.

hashCode

public int hashCode()

Returns a hash code value for this severity. This method is supported for the benefit of hash tables. As instances of this type are immutable, the hash code is a fixed number that is already determined during construction.

If two severities are equal (as indicated by the return value of equals(Object)), they also have the same hash code. However, the fact that two messages have the same hash code does not imply that they are equal, even though the implementation of this method has been carefully designed to make such a collision extremely unlikely.

Overrides:

hashCode in class java.lang.Object

Returns:

hash code suitable for use by a hash table.

equals

public boolean equals(java.lang.Object obj)

Tells whether the specified object represents the same severity.

Two severities are considered equal if they have the same severity level and if they both have the same "severe" flag (either set for both or not set for both).

Overrides:

equals in class java.lang.Object

Parameters:

obj - reference object with which this object is compared.

Returns:

true if obj is a severity that has the same level and severe flag as this severity, false otherwise.

toString

public java.lang.String toString()

Returns a string representation of this severity. The string representation is the string representation of the severity level plus the string "severe" added in parentheses if the severe flag is set. The ERROR severity level is an exception to this rule: If the "severe" bit is set for this level, the string "FATAL" is returned instead of "ERROR".

Overrides:

toString in class java.lang.Object

Returns:

string representation of this severity.