org.milyn.cdr.annotation

Enum ConfigParam.Use

java.lang.Object

java.lang.Enum<ConfigParam.Use>

org.milyn.cdr.annotation.ConfigParam.Use

All Implemented Interfaces:

Serializable, Comparable<ConfigParam.Use>

Enclosing class:

ConfigParam

public static enum ConfigParam.Use
extends Enum<ConfigParam.Use>

Configuration paramater use.

Enum Constant Summary

Enum Constants

Enum Constant and Description
OPTIONAL Parameter is optional.
REQUIRED Parameter is required.

Method Summary

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

REQUIRED

public static final ConfigParam.Use REQUIRED

Parameter is required.

OPTIONAL

public static final ConfigParam.Use OPTIONAL

Parameter is optional.

Method Detail

values

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

Returns:

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

valueOf

public static ConfigParam.Use 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