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

# Enum Jdbc2SchemaOptionName

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

Alle implementierten Schnittstellen:
  `Serializable`, `Comparable<Jdbc2SchemaOptionName>`, `java.lang.constant.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 $

- ## Verschachtelte Klassen - Übersicht

  ## Von Klasse geerbte verschachtelte Klassen/Schnittstellen java.lang.Enum

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

- ## Enum-Konstanten - Übersicht

  Enum-Konstanten
  Enum-Konstante
  Beschreibung
  `DATABASE_NAME`
  The name of the database to generate.

- ## Methodenübersicht

  Modifizierer und Typ
  Methode
  Beschreibung
  `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)`
  Gibt die Enumerationskonstante dieses Typs mit dem angegebenen Namen zurück.
  `static Jdbc2SchemaOptionName[]`
  `values()`
  Gibt ein Array mit den Konstanten dieses Enum-Typs in der Reihenfolge ihrer Deklaration zurück.

  ### Von Klasse geerbte Methoden java.lang.Enum

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

  ### Von Klasse geerbte Methoden java.lang.Object

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

- ## Enum-Konstanten - Details

  - ### DATABASE_NAME

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

- ## Methodendetails

  - ### values

    public static Jdbc2SchemaOptionName[] values()
    Gibt ein Array mit den Konstanten dieses Enum-Typs in der Reihenfolge ihrer Deklaration zurück.
    Gibt zurück:
      ein Array mit den Konstanten dieses Enumerationstyps in der Reihenfolge ihrer Deklaration

  - ### valueOf

    public static Jdbc2SchemaOptionName valueOf(String name)
    Gibt die Enumerationskonstante dieses Typs mit dem angegebenen Namen zurück. Die Zeichenfolge muss exakt mit einer ID übereinstimmen, mit der eine Enumerationskonstante in diesem Typ deklariert wird. (Zusätzliche Leerzeichen sind nicht zulässig.)
    Parameter:
      `name` - Name der zurückzugebenden Enumerationskonstante.
    Gibt zurück:
      Enumerationskonstante mit dem angegebenen Namen
    Löst aus:
      `IllegalArgumentException` - wenn dieser Enumerationstyp keine Konstante mit dem angegebenen Namen enthält
      `NullPointerException` - wenn das Argument nicht angegeben wird

  - ### getName

    public String getName()
    Returns the name of the option.
    Angegeben von:
      `getName` in Schnittstelle `OptionName`
    Gibt zurück:
      the fully qualified name of the option, not null.

  - ### isRequired

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

  - ### toString

    public String toString()
    Setzt außer Kraft:
      `toString` in Klasse `Enum<Jdbc2SchemaOptionName>`

  - ### checkRequiredOptions

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