Package org.apache.torque.templates.transformer.jdbc2schema

# Enum Class Jdbc2SchemaOptionName

java.lang.Object
java.lang.Enum<Jdbc2SchemaOptionName>
org.apache.torque.templates.transformer.jdbc2schema.Jdbc2SchemaOptionName

All Implemented Interfaces:
  `Serializable`, `Comparable<Jdbc2SchemaOptionName>`, `Constable`, `OptionName`

public enum Jdbc2SchemaOptionName extends Enum<Jdbc2SchemaOptionName> implements OptionName
The option names which are used in the java code of the jdbc2schema templates. $Id: Jdbc2SchemaOptionName.java 1917240 2024-04-21 13:22:54Z tv $

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant
  Description
  `DATABASE_NAME`
  The name of the database to generate.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static void`
  `checkRequiredOptions(ControllerState controllerState)`
  Checks whether all required options are set.
  `String`
  `getName()`
  Returns the name of the option.
  `boolean`
  `isRequired()`
  Returns whether this option must be set.
  `String`
  `toString()`
  `static Jdbc2SchemaOptionName`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static Jdbc2SchemaOptionName[]`
  `values()`
  Returns an array containing the constants of this enum class, in the order they are declared.

  ### Methods inherited from class java.lang.Enum

  `clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf`

  ### Methods inherited from class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Enum Constant Details

  - ### DATABASE_NAME

    public static final Jdbc2SchemaOptionName DATABASE_NAME
    The name of the database to generate.

- ## Method Details

  - ### values

    public static Jdbc2SchemaOptionName[] 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 Jdbc2SchemaOptionName 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

  - ### getName

    public String getName()
    Returns the name of the option.
    Specified by:
      `getName` in interface `OptionName`
    Returns:
      the fully qualified name of the option, not null.

  - ### isRequired

    public boolean isRequired()
    Returns whether this option must be set.
    Returns:
      true if the option must be set, false if it may be set.

  - ### toString

    public String toString()
    Overrides:
      `toString` in class `Enum<Jdbc2SchemaOptionName>`

  - ### checkRequiredOptions

    public static void checkRequiredOptions(ControllerState controllerState) throws SourceTransformerException
    Checks whether all required options are set.
    Parameters:
      `controllerState` - the current controller state, not null.
    Throws:
      `SourceTransformerException` - if a required option is not set.