IBM WebSphere Application ServerTM
Release 8

com.ibm.websphere.sib
Class Reliability

java.lang.Object
  extended by com.ibm.websphere.sib.Reliability
All Implemented Interfaces:
java.lang.Comparable

public final class Reliability
extends java.lang.Object
implements java.lang.Comparable

Reliability is a type-safe enumeration for Reliability quality of service values.


Field Summary
static Reliability ASSURED_PERSISTENT
          Constant denoting DeliveryMode Type - Assured Persistent
static java.lang.String ASSURED_PERSISTENT_STRING
          Constant naming DeliveryMode Type - Assured Persistent.
static Reliability BEST_EFFORT_NONPERSISTENT
          Constant denoting DeliveryMode Type - Best Effort Non-persistent
static java.lang.String BEST_EFFORT_NONPERSISTENT_STRING
          Constant naming DeliveryMode Type - Best Effort Non-persistent.
static Reliability EXPRESS_NONPERSISTENT
          Constant denoting DeliveryMode Type - Express Non-persistent
static java.lang.String EXPRESS_NONPERSISTENT_STRING
          Constant naming DeliveryMode Type - Express Non-persistent.
static int MAX_INDEX
          Constant denoting the maximum index.
static Reliability NONE
          Constant denoting a currently unknown or no persistence type
static Reliability RELIABLE_NONPERSISTENT
          Constant denoting DeliveryMode Type - Reliable Non-persistent
static java.lang.String RELIABLE_NONPERSISTENT_STRING
          Constant naming DeliveryMode Type - Reliable Non-persistent.
static Reliability RELIABLE_PERSISTENT
          Constant denoting DeliveryMode Type - Reliable Persistent
static java.lang.String RELIABLE_PERSISTENT_STRING
          Constant naming DeliveryMode Type - Reliable Persistent.
 
Method Summary
 int compareTo(java.lang.Object other)
          Compare this Reliability with another.
 int getIndex()
          Returns the index of the Reliability.
 java.lang.Byte getPersistence()
          Returns the JMS Persistence value for the Reliability.
static Reliability getReliability(java.lang.Byte aValue)
          Returns the corresponding Reliability for a given Byte.
static Reliability getReliability(int aValue)
          Returns the corresponding Reliability for a given integer.
static Reliability getReliabilityByIndex(int mpIndex)
          Returns the corresponding Reliability for a given index.
static Reliability getReliabilityByName(java.lang.String name)
          Returns the corresponding Reliability for a given name.
 java.lang.Byte toByte()
          Returns the Byte representation of the Reliability.
 int toInt()
          Returns the integer representation of the Reliability.
 java.lang.String toString()
          Returns the name of the Reliability.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

BEST_EFFORT_NONPERSISTENT_STRING

public static final java.lang.String BEST_EFFORT_NONPERSISTENT_STRING
Constant naming DeliveryMode Type - Best Effort Non-persistent. This constant should NOT be accessed by any code outside the SIBus. It is only public so that it can be accessed by other SIBus components.

See Also:
Constant Field Values

EXPRESS_NONPERSISTENT_STRING

public static final java.lang.String EXPRESS_NONPERSISTENT_STRING
Constant naming DeliveryMode Type - Express Non-persistent. This constant should NOT be accessed by any code outside the SIBus. It is only public so that it can be accessed by other SIBus components.

See Also:
Constant Field Values

RELIABLE_NONPERSISTENT_STRING

public static final java.lang.String RELIABLE_NONPERSISTENT_STRING
Constant naming DeliveryMode Type - Reliable Non-persistent. This constant should NOT be accessed by any code outside the SIBus. It is only public so that it can be accessed by other SIBus components.

See Also:
Constant Field Values

RELIABLE_PERSISTENT_STRING

public static final java.lang.String RELIABLE_PERSISTENT_STRING
Constant naming DeliveryMode Type - Reliable Persistent. This constant should NOT be accessed by any code outside the SIBus. It is only public so that it can be accessed by other SIBus components.

See Also:
Constant Field Values

ASSURED_PERSISTENT_STRING

public static final java.lang.String ASSURED_PERSISTENT_STRING
Constant naming DeliveryMode Type - Assured Persistent. This constant should NOT be accessed by any code outside the SIBus. It is only public so that it can be accessed by other SIBus components.

See Also:
Constant Field Values

NONE

public static final Reliability NONE
Constant denoting a currently unknown or no persistence type


BEST_EFFORT_NONPERSISTENT

public static final Reliability BEST_EFFORT_NONPERSISTENT
Constant denoting DeliveryMode Type - Best Effort Non-persistent


EXPRESS_NONPERSISTENT

public static final Reliability EXPRESS_NONPERSISTENT
Constant denoting DeliveryMode Type - Express Non-persistent


RELIABLE_NONPERSISTENT

public static final Reliability RELIABLE_NONPERSISTENT
Constant denoting DeliveryMode Type - Reliable Non-persistent


RELIABLE_PERSISTENT

public static final Reliability RELIABLE_PERSISTENT
Constant denoting DeliveryMode Type - Reliable Persistent


ASSURED_PERSISTENT

public static final Reliability ASSURED_PERSISTENT
Constant denoting DeliveryMode Type - Assured Persistent


MAX_INDEX

public static final int MAX_INDEX
Constant denoting the maximum index. This constant should NOT be accessed by any code outside the SIBus. It is only public so that it can be accessed by other SIBus components.

Method Detail

toString

public final java.lang.String toString()
Returns the name of the Reliability.

Overrides:
toString in class java.lang.Object
Returns:
The name of the Reliability instance.

compareTo

public final int compareTo(java.lang.Object other)
Compare this Reliability with another.

The method implements java.util.Comaparable.compareTo and therefore has the same semantics.

Specified by:
compareTo in interface java.lang.Comparable
Parameters:
other - The Reliability this is to be compared with.
Returns:
An int indicating the relative values as follows:
>0: this > other (i.e. more Reliable).
0: this == other
<0: this < other (i.e. less Reliable).

getReliability

public static final Reliability getReliability(int aValue)
Returns the corresponding Reliability for a given integer. This method should NOT be called by any code outside the SIBus. It is only public so that it can be accessed by other SIBus components.

Parameters:
aValue - The integer for which an Reliability is required.
Returns:
The corresponding Reliability

toInt

public final int toInt()
Returns the integer representation of the Reliability. This method should NOT be called by any code outside the MFP component. It is only public so that it can be accessed by sub-packages.

Returns:
The int representation of the Reliability instance.

getReliabilityByName

public static final Reliability getReliabilityByName(java.lang.String name)
                                              throws java.lang.NullPointerException,
                                                     java.lang.IllegalArgumentException
Returns the corresponding Reliability for a given name. This method should NOT be called by any code outside the SIBus. It is only public so that it can be accessed by other SIBus components.

Parameters:
name - The toString value of a Reliability constant.
Returns:
The corresponding Reliability
Throws:
java.lang.NullPointerException
java.lang.IllegalArgumentException

getReliabilityByIndex

public static final Reliability getReliabilityByIndex(int mpIndex)
Returns the corresponding Reliability for a given index. This method should NOT be called by any code outside the SIBus. It is only public so that it can be accessed by other SIBus components.

Parameters:
mpIndex - The MP index for which an Reliability is required. MP use -1 for NONE and start at 0 for real values.
Returns:
The corresponding Reliability

getIndex

public final int getIndex()
Returns the index of the Reliability. This method should NOT be called by any code outside the SIBus. It is only public so that it can be accessed by other SIBus components.

Returns:
The index of the Reliability instance.

getReliability

public static final Reliability getReliability(java.lang.Byte aValue)
Returns the corresponding Reliability for a given Byte. This method should NOT be called by any code outside the MFP component. It is only public so that it can be accessed by sub-packages.

Parameters:
aValue - The Byte for which an Reliability is required.
Returns:
The corresponding Reliability

toByte

public final java.lang.Byte toByte()
Returns the Byte representation of the Reliability. This method should NOT be called by any code outside the MFP component. It is only public so that it can be accessed by sub-packages.

Returns:
The Byte representation of the Reliability instance.

getPersistence

public final java.lang.Byte getPersistence()
Returns the JMS Persistence value for the Reliability. This method should NOT be called by any code outside the MFP component. It is only public so that it can be accessed by sub-packages.

Returns:
The persistence Byte from the Reliability instance.

IBM WebSphere Application ServerTM
Release 8