plugins.adufour.vars.util
Enum VarReferencingPolicy

java.lang.Object
  java.lang.Enum<VarReferencingPolicy>
      plugins.adufour.vars.util.VarReferencingPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<VarReferencingPolicy>

public enum VarReferencingPolicy
extends java.lang.Enum<VarReferencingPolicy>

Enumeration of possible referencing policies of a Variable

Author:

Alexandre Dufour

Enum Constant Summary

BOTH
The variable may reference or be referenced by another variable (default)

IN
The variable may reference but not be referenced by another variable

NONE
The variable may neither reference nor be referenced by another variable

OUT
The variable may not reference but may be referenced by another variable

Method Summary

static VarReferencingPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static VarReferencingPolicy[]	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

NONE

public static final VarReferencingPolicy NONE

The variable may neither reference nor be referenced by another variable

IN

public static final VarReferencingPolicy IN

The variable may reference but not be referenced by another variable

OUT

public static final VarReferencingPolicy OUT

The variable may not reference but may be referenced by another variable

BOTH

public static final VarReferencingPolicy BOTH

The variable may reference or be referenced by another variable (default)

Method Detail

values

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

Returns:

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

valueOf

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