org.roscopeco.janno.util
Enum ParamPolicy

java.lang.Object
  java.lang.Enum<ParamPolicy>
      org.roscopeco.janno.util.ParamPolicy

All Implemented Interfaces:

Serializable, Comparable<ParamPolicy>

public enum ParamPolicy
extends Enum<ParamPolicy>

Basic parameter policies. Each Param supplied to a StrictParams annotation must have an associated policy, indicating the policy for that parameter (one of required, allowed or disallowed).

Version:

$Revision: 1.1 $ $Date: 2005/07/03 01:26:31 $

Author:

Ross Bamford (rosco<at>roscopeco.co.uk)

Enum Constant Summary

ALLOWED

DISALLOWED

REQUIRED

Method Summary

static ParamPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static ParamPolicy[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REQUIRED

public static final ParamPolicy REQUIRED

ALLOWED

public static final ParamPolicy ALLOWED

DISALLOWED

public static final ParamPolicy DISALLOWED

Method Detail

values

public static final ParamPolicy[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(ParamPolicy c : ParamPolicy.values())
        System.out.println(c);

Returns:

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

valueOf

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