ch.ralscha.extdirectspring.annotation

Enum ExtDirectMethodType

java.lang.Object

java.lang.Enum<ExtDirectMethodType>

ch.ralscha.extdirectspring.annotation.ExtDirectMethodType

All Implemented Interfaces:

Serializable, Comparable<ExtDirectMethodType>

public enum ExtDirectMethodType
extends Enum<ExtDirectMethodType>

Enumeration of all possible remote method types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORM_LOAD Specifies a method that handles a form load.
FORM_POST Specifies a method that handles a form post (with or without upload).
POLL Specifies a method that handles polling.
SIMPLE Specifies a simple remote method.
SIMPLE_NAMED Specifies a simple remote method with named parameters.
SSE Method that handles Server-Sent Events requests (EventSource)
STORE_MODIFY Specifies a method that handles create, update or destroy calls from DirectStore.
STORE_READ Specifies a method that handles read calls from DirectStore.
TREE_LOAD Specifies a method that handles read calls from TreeLoader or TreeStore

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	isValid(String methodName, Class<?> clazz, Method method) Checks if the annotated method contains non supported annotation properties and contains non supported parameters and/or parameter annotations.
static ExtDirectMethodType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExtDirectMethodType[]	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

SIMPLE

public static final ExtDirectMethodType SIMPLE

Specifies a simple remote method. This type of method can have any parameter and any return type but must not contain a parameter with @RequestParam annotated.

SIMPLE_NAMED

public static final ExtDirectMethodType SIMPLE_NAMED

Specifies a simple remote method with named parameters. This type of method can have any parameter and any return type.

FORM_LOAD

public static final ExtDirectMethodType FORM_LOAD

Specifies a method that handles a form load.

STORE_READ

public static final ExtDirectMethodType STORE_READ

Specifies a method that handles read calls from DirectStore.

STORE_MODIFY

public static final ExtDirectMethodType STORE_MODIFY

Specifies a method that handles create, update or destroy calls from DirectStore.

FORM_POST

public static final ExtDirectMethodType FORM_POST

Specifies a method that handles a form post (with or without upload). A FORM_POST method must not return anything. This type of method must be annotated with @RequestMapping. @RequestMapping must contain a value and a method of type RequestMethod.POST. This kind of method must be member of a bean annotated with @Controller.

TREE_LOAD

public static final ExtDirectMethodType TREE_LOAD

Specifies a method that handles read calls from TreeLoader or TreeStore

POLL

public static final ExtDirectMethodType POLL

Specifies a method that handles polling.

SSE

public static final ExtDirectMethodType SSE

Method that handles Server-Sent Events requests (EventSource)

Method Detail

values

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

Returns:

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

valueOf

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

isValid

public abstract boolean isValid(String methodName,
              Class<?> clazz,
              Method method)

Checks if the annotated method contains non supported annotation properties and contains non supported parameters and/or parameter annotations. Method logs warnings and errors. Check is running during startup of the application. If return value is false the method is not registered and cannot be called from the client.

Parameters:

methodName - Name of the bean and method for logging purpose. e.g. 'bean.methodname'

clazz - The class where the method is member of

method - The annotated method

Returns:

true if the method does not contains any errors.