Package org.atmosphere.cpr

Enum AtmosphereFramework.MetaServiceAction

java.lang.Object

java.lang.Enum<AtmosphereFramework.MetaServiceAction>

org.atmosphere.cpr.AtmosphereFramework.MetaServiceAction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AtmosphereFramework.MetaServiceAction>

Enclosing class:

AtmosphereFramework

public static enum AtmosphereFramework.MetaServiceAction
extends java.lang.Enum<AtmosphereFramework.MetaServiceAction>

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

Since:

2.2.0

Version:

1.0

Author:

Guillaume DROUET

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, java.lang.Class<?> clazz)	Applies this action to given class.
static AtmosphereFramework.MetaServiceAction	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static AtmosphereFramework.MetaServiceAction[]	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

INSTALL

public static final AtmosphereFramework.MetaServiceAction INSTALL

Install service.

EXCLUDE

public static final AtmosphereFramework.MetaServiceAction EXCLUDE

Exclude service.

Method Detail

values

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

Returns:

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

valueOf

public static AtmosphereFramework.MetaServiceAction 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

apply

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

Applies this action to given class.

Parameters:

fwk - the framework

clazz - the class

Throws:

java.lang.Exception - if procedure fails