net.rim.pushsdk.pap.control
Enum DeliveryMethod

java.lang.Object
  extended by java.lang.Enum<DeliveryMethod>
      extended by net.rim.pushsdk.pap.control.DeliveryMethod
All Implemented Interfaces:
Serializable, Comparable<DeliveryMethod>

public enum DeliveryMethod
extends Enum<DeliveryMethod>

Defines the type of reliability to use for message delivery.

Author:
mdicesare

Enum Constant Summary
CONFIRMED
          Signifies that client confirmation of the message delivery is available.
NOTSPECIFIED
          Signifies that there is no preference between confirmed and unconfirmed delivery of the message.
PREFERCONFIRMED
          Signifies that the PPG should try to deliver the message as confirmed, but may use another method if not able to use the preferred choice.
UNCONFIRMED
          Signifies that client confirmation of the message delivery is not available.
 
Method Summary
 String getDeliveryMethod()
          Gets the value of the delivery method.
static DeliveryMethod getDeliveryMethod(String deliveryMethod)
          Gets the delivery method associated with the given string.
 String toString()
          Calls getDeliveryMethod().
static DeliveryMethod valueOf(String name)
          Returns the enum constant of this type with the specified name.
static DeliveryMethod[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

CONFIRMED

public static final DeliveryMethod CONFIRMED
Signifies that client confirmation of the message delivery is available.


PREFERCONFIRMED

public static final DeliveryMethod PREFERCONFIRMED
Signifies that the PPG should try to deliver the message as confirmed, but may use another method if not able to use the preferred choice.


UNCONFIRMED

public static final DeliveryMethod UNCONFIRMED
Signifies that client confirmation of the message delivery is not available.


NOTSPECIFIED

public static final DeliveryMethod NOTSPECIFIED
Signifies that there is no preference between confirmed and unconfirmed delivery of the message.

Method Detail

values

public static DeliveryMethod[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (DeliveryMethod c : DeliveryMethod.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static DeliveryMethod valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

getDeliveryMethod

public String getDeliveryMethod()
Gets the value of the delivery method.

Returns:
the delivery method

getDeliveryMethod

public static DeliveryMethod getDeliveryMethod(String deliveryMethod)
Gets the delivery method associated with the given string.

Parameters:
deliveryMethod - the delivery method as a string
Returns:
the delivery method
Throws:
IllegalArgumentException - if the delivery method string passed in was invalid

toString

public String toString()
Calls getDeliveryMethod().

Overrides:
toString in class Enum<DeliveryMethod>


Copyright © 2011 Research In Motion. All Rights Reserved.