net.rim.pushsdk.subscription
Enum SubscriberType

java.lang.Object
  extended by java.lang.Enum<SubscriberType>
      extended by net.rim.pushsdk.subscription.SubscriberType
All Implemented Interfaces:
Serializable, Comparable<SubscriberType>

public enum SubscriberType
extends Enum<SubscriberType>

The type of the subscriber.

Since:
1.1
Author:
mdandrea

Enum Constant Summary
ENTERPRISE
          An enterprise (BES) push subscriber.
PUBLIC
          A public (BIS) push subscriber.
 
Method Summary
static SubscriberType getType(String subscriberType)
          Gets the subscriber type associated with the passed in string.
static SubscriberType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static SubscriberType[] 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, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

PUBLIC

public static final SubscriberType PUBLIC
A public (BIS) push subscriber.


ENTERPRISE

public static final SubscriberType ENTERPRISE
An enterprise (BES) push subscriber.

Method Detail

values

public static SubscriberType[] 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 (SubscriberType c : SubscriberType.values())
    System.out.println(c);

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

valueOf

public static SubscriberType 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

getType

public static SubscriberType getType(String subscriberType)
Gets the subscriber type associated with the passed in string.

Parameters:
subscriberType - a subscriber type as a string (Note: As of release 1.1, this string should never be null.)
Returns:
a subscriber type matching the string passed in or null if the string passed in is null
Throws:
SubIllegalArgumentException - if the type passed in is invalid (i.e. anything but null or the valid values)


Copyright © 2011 Research In Motion. All Rights Reserved.