Package org.atmosphere.cpr

Enum BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY

java.lang.Object

java.lang.Enum<BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY>

org.atmosphere.cpr.BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY>

Enclosing class:

BroadcasterLifeCyclePolicy

public static enum BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY
extends java.lang.Enum<BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMPTY	If there is no AtmosphereResource associated with the Broadcaster, release all resources.
EMPTY_DESTROY	If there is no AtmosphereResource associated with the Broadcaster, release all resources, and destroy the broadcaster.
IDLE	Release all resources associated with the Broadcaster when the idle time expires.
IDLE_DESTROY	Release all resources associated with the Broadcaster when the idle time expires and destroy the Broadcaster.
IDLE_RESUME	Release all resources associated with the Broadcaster when the idle time expires.
NEVER	Never release or destroy the Broadcaster.

Method Summary

Modifier and Type	Method	Description
static BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY[]	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

IDLE

public static final BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY IDLE

Release all resources associated with the Broadcaster when the idle time expires. Suspended AtmosphereResource will NOT get resumed. Broadcaster.releaseExternalResources() will be invoked.

IDLE_DESTROY

public static final BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY IDLE_DESTROY

Release all resources associated with the Broadcaster when the idle time expires and destroy the Broadcaster. This operation removes the Broadcaster from it's associated BroadcasterFactory Broadcaster.destroy() will be invoked. Suspended AtmosphereResource will NOT get resumed.

IDLE_RESUME

public static final BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY IDLE_RESUME

Release all resources associated with the Broadcaster when the idle time expires. All associated AtmosphereResource WILL BE resumed and this broadcaster destroyed.

EMPTY

public static final BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY EMPTY

If there is no AtmosphereResource associated with the Broadcaster, release all resources. Broadcaster.releaseExternalResources() will be invoked.

EMPTY_DESTROY

public static final BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY EMPTY_DESTROY

If there is no AtmosphereResource associated with the Broadcaster, release all resources, and destroy the broadcaster. This operation removes the Broadcaster from its associated BroadcasterFactory Broadcaster.destroy() will be invoked

NEVER

public static final BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY NEVER

Never release or destroy the Broadcaster.

Method Detail

values

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

Returns:

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

valueOf

public static BroadcasterLifeCyclePolicy.ATMOSPHERE_RESOURCE_POLICY valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null