com.pusher.client.channel
Enum ChannelState

java.lang.Object
  extended by java.lang.Enum<ChannelState>
      extended by com.pusher.client.channel.ChannelState
All Implemented Interfaces:
Serializable, Comparable<ChannelState>

public enum ChannelState
extends Enum<ChannelState>

Used to identify the state of the channel e.g. subscribed or unsubscribed.


Enum Constant Summary
FAILED
           
INITIAL
           
SUBSCRIBE_SENT
           
SUBSCRIBED
           
UNSUBSCRIBED
           
 
Method Summary
static ChannelState valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ChannelState[] 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

INITIAL

public static final ChannelState INITIAL

SUBSCRIBE_SENT

public static final ChannelState SUBSCRIBE_SENT

SUBSCRIBED

public static final ChannelState SUBSCRIBED

UNSUBSCRIBED

public static final ChannelState UNSUBSCRIBED

FAILED

public static final ChannelState FAILED
Method Detail

values

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

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

valueOf

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


Copyright © 2013 Pusher. All Rights Reserved.