org.atmosphere.stomp.interceptor

Enum FrameInterceptor.PropertyClass

java.lang.Object

java.lang.Enum<FrameInterceptor.PropertyClass>

org.atmosphere.stomp.interceptor.FrameInterceptor.PropertyClass

All Implemented Interfaces:

Serializable, Comparable<FrameInterceptor.PropertyClass>

Enclosing class:

FrameInterceptor

public static enum FrameInterceptor.PropertyClass
extends Enum<FrameInterceptor.PropertyClass>

This enum is dedicated to properties that represents a class to instantiate.

Since:

0.1

Version:

1.0

Author:

Guillaume DROUET

Enum Constant Summary

Enum Constants

Enum Constant and Description
STOMP_FORMAT_CLASS Setting that specifies the StompFormat implementation class used by the interceptor.

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	retrieve(Class<T> desiredType, org.atmosphere.cpr.AtmosphereConfig config) Checks in the AtmosphereConfig if the propertyName is defined as an init-param and instantiate the appropriate class.
String	toString()
static FrameInterceptor.PropertyClass	valueOf(String name) Returns the enum constant of this type with the specified name.
static FrameInterceptor.PropertyClass[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STOMP_FORMAT_CLASS

public static final FrameInterceptor.PropertyClass STOMP_FORMAT_CLASS

Setting that specifies the StompFormat implementation class used by the interceptor.

Method Detail

values

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

Returns:

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

valueOf

public static FrameInterceptor.PropertyClass 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

retrieve

public <T> T retrieve(Class<T> desiredType,
             org.atmosphere.cpr.AtmosphereConfig config)

Checks in the AtmosphereConfig if the propertyName is defined as an init-param and instantiate the appropriate class.

If instantiation fails, the exception is logged and null is returned.

Type Parameters:

T - the generic for modular call

Parameters:

desiredType - the type to be returned

config - the configuration that provides parameters

Returns:

the instance of the expected class, null if an error occurs

toString

public String toString()

Overrides:

toString in class Enum<FrameInterceptor.PropertyClass>