Package org.atmosphere.cpr

Enum Class MetaServiceAction

java.lang.Object

java.lang.Enum<MetaServiceAction>

org.atmosphere.cpr.MetaServiceAction

All Implemented Interfaces:

Serializable, Comparable<MetaServiceAction>, Constable

public enum MetaServiceAction
extends Enum<MetaServiceAction>

This enumeration represents all possible actions to specify in a meta service file.

Since:

2.2.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXCLUDE	Exclude service.
INSTALL	Install service.

Method Summary

Modifier and Type	Method	Description
void	apply(AtmosphereFramework fwk, Class<?> clazz)	Applies this action to given class.
static MetaServiceAction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MetaServiceAction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTALL

public static final MetaServiceAction INSTALL

Install service.

EXCLUDE

public static final MetaServiceAction EXCLUDE

Exclude service.

Method Details

values

public static MetaServiceAction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static MetaServiceAction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

apply

public void apply(AtmosphereFramework fwk,
 Class<?> clazz)
           throws Exception

Applies this action to given class.

Parameters:

fwk - the framework

clazz - the class

Throws:

Exception - if procedure fails