Enum Class Variable.Scope

java.lang.Object
java.lang.Enum<Variable.Scope>
org.apache.torque.generator.variable.Variable.Scope
All Implemented Interfaces:
Serializable, Comparable<Variable.Scope>, Constable
Enclosing class:
Variable

public static enum Variable.Scope extends Enum<Variable.Scope>
The scope of a variable.
  • Enum Constant Details

    • OUTLET

      public static final Variable.Scope OUTLET
      The scope of the variable is limited to the current outlet.
    • CHILDREN

      public static final Variable.Scope CHILDREN
      The scope of the variable is the current outlet and recursively all the outlets in the merge points accessed in the generation process.
    • FILE

      public static final Variable.Scope FILE
      The variable is visible throughout the generation process of this file.
    • GLOBAL

      public static final Variable.Scope GLOBAL
      The variable is visible throughout the whole generation process.
  • Method Details

    • values

      public static Variable.Scope[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static Variable.Scope valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null