Package org.apache.torque.adapter

# Enum IDMethod

java.lang.Object
java.lang.Enum<IDMethod>
org.apache.torque.adapter.IDMethod

Alle implementierten Schnittstellen:
  `Serializable`, `Comparable<IDMethod>`, `java.lang.constant.Constable`

public enum IDMethod extends Enum<IDMethod>
Interface for various ID retrieval method types (i.e. auto-increment, sequence, ID broker, etc.).

Version:
  $Id: IDMethod.java 1917245 2024-04-21 14:06:23Z tv $
Autor:
  Daniel Rall

- ## 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
  `AUTO_INCREMENT`
  Key generation via auto-increment.
  `ID_BROKER`
  Key generation via the IDBroker table.
  `NATIVE`
  Key generation via database-specific ID method (i.e. auto-increment for MySQL, sequence for Oracle, etc.).
  `NO_ID_METHOD`
  No RDBMS key generation (keys may be generated by the application).
  `SEQUENCE`
  Key generation via sequences.

- ## Methodenübersicht

  Modifizierer und Typ
  Methode
  Beschreibung
  `static IDMethod`
  `getIdMethod(String idMethod)`
  Returns the id method for a id method name.
  `String`
  `toString()`
  `static IDMethod`
  `valueOf(String name)`
  Gibt die Enumerationskonstante dieses Typs mit dem angegebenen Namen zurück.
  `static IDMethod[]`
  `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

  - ### NATIVE

    public static final IDMethod NATIVE
    Key generation via database-specific ID method (i.e. auto-increment for MySQL, sequence for Oracle, etc.).

  - ### AUTO_INCREMENT

    public static final IDMethod AUTO_INCREMENT
    Key generation via auto-increment.

  - ### SEQUENCE

    public static final IDMethod SEQUENCE
    Key generation via sequences.

  - ### ID_BROKER

    public static final IDMethod ID_BROKER
    Key generation via the IDBroker table.

  - ### NO_ID_METHOD

    public static final IDMethod NO_ID_METHOD
    No RDBMS key generation (keys may be generated by the application).

- ## Methodendetails

  - ### values

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

  - ### toString

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

  - ### getIdMethod

    public static IDMethod getIdMethod(String idMethod)
    Returns the id method for a id method name.
    Parameter:
      `idMethod` - the name of the id method.
    Gibt zurück:
      the id method.
    Löst aus:
      `IllegalArgumentException` - if idMethod is not a known name.