com.sap.aii.af.service.administration.api.monitoring

Class ChannelState

java.lang.Object

com.sap.aii.af.service.administration.api.monitoring.ChannelState

All Implemented Interfaces:

Serializable, Comparable

public class ChannelState
extends Object
implements Serializable, Comparable

The ChannelState class is a typed enumeration for the status of a channel in the Adapter Monitoring API. Its static members can be used to express a certain channel state. Available states are:

• ERROR
• OK
• INACTIVE

The states have a precedence in the above shown order.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ChannelState	ERROR Indicates that the channel is either configured incorrectly or has encountered another error that prevents it from processing messages.
static ChannelState	INACTIVE Indicates that an adapter channel is inactive.
static ChannelState	OK Indicates that the channel is configured correctly and ready to process messages.
protected String	text

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChannelState(String text, int value) Protected constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ChannelState s) Compare two ChannelState instances.
int	compareTo(Object o) Compare two ChannelState instances.
protected Object	readResolve()
String	toString() Converts this object into a string representation.
static ChannelState	valueOf(String statusString) Get one of the static class members from their depending String as returned from toString.

Methods inherited from class java.lang.Object

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

Field Detail

ERROR

public static final ChannelState ERROR

Indicates that the channel is either configured incorrectly or has encountered another error that prevents it from processing messages.

INACTIVE

public static final ChannelState INACTIVE

Indicates that an adapter channel is inactive.

OK

public static final ChannelState OK

Indicates that the channel is configured correctly and ready to process messages.

text

protected String text

Constructor Detail

ChannelState

protected ChannelState(String text,
                       int value)

Protected constructor.

Parameters:

text - the state text

value - the state value (for comparison purposes)

Method Detail

toString

public String toString()

Converts this object into a string representation.

Overrides:

toString in class Object

Returns:

the string representation of this ChannelState

valueOf

public static ChannelState valueOf(String statusString)

Get one of the static class members from their depending String as returned from toString.

Parameters:

statusString - a String as returned by the toString method

Returns:

one of the static members of this class

Throws:

NullPointerException - if the argument is null

IllegalArgumentException - if the argument is a unknown status String

readResolve

protected Object readResolve()
                      throws ObjectStreamException

Throws:

ObjectStreamException

compareTo

public int compareTo(Object o)

Compare two ChannelState instances.

Specified by:

compareTo in interface Comparable

Parameters:

o - Another ChannelState instance

Returns:

the value 0 if the argument is the same ChannelState as this ChannelState; a value less than 0 if the argument is a ChannelState with a higher precedence than this ChannelState; and a value greater than 0 if the argument is a ChannelState with a lower precedence less than this ChannelState.

Throws:

ClassCastException - if the argument is not of type ChannelState

NullPointerException - if the argument is null

compareTo

public int compareTo(ChannelState s)

Compare two ChannelState instances.

Parameters:

s - Another ChannelState instance

Returns:

the value 0 if the argument is the same ChannelState as this ChannelState; a value less than 0 if the argument is a ChannelState with a higher precedence than this ChannelState; and a value greater than 0 if the argument is a ChannelState with a lower precedence less than this ChannelState.

Throws:

NullPointerException - if the argumant is null