Enum Class IDMethod

java.lang.Object
java.lang.Enum<IDMethod>
org.apache.torque.adapter.IDMethod
All Implemented Interfaces:
Serializable, Comparable<IDMethod>, 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 $
Author:
Daniel Rall
  • Enum Constant 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).
  • Method Details

    • values

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

      public String toString()
      Overrides:
      toString in class Enum<IDMethod>
    • getIdMethod

      public static IDMethod getIdMethod(String idMethod)
      Returns the id method for a id method name.
      Parameters:
      idMethod - the name of the id method.
      Returns:
      the id method.
      Throws:
      IllegalArgumentException - if idMethod is not a known name.