net.sf.eodsql
Enum GeneratedKeys

java.lang.Object
  java.lang.Enum<GeneratedKeys>
      net.sf.eodsql.GeneratedKeys

All Implemented Interfaces:

Serializable, Comparable<GeneratedKeys>

public enum GeneratedKeys
extends Enum<GeneratedKeys>

Enumeration used by the @Update annotation to specify what to do with keys generated by the database.

Author:

jason

See Also:

Update, AutoGeneratedKeys

Enum Constant Summary

NO_KEYS_RETURNED
Specifies that a normal Statement.executeUpdate(java.lang.String) should be performed.

RETURNED_KEYS_COLUMNS_SPECIFIED
This specifies that the generated keys should be explicidly requested from the JDBC driver by name.

RETURNED_KEYS_DRIVER_DEFINED
Specifies that the JDBC driver should return whatever keys it decides to.

Method Summary

static GeneratedKeys	valueOf(String name) Returns the enum constant of this type with the specified name.
static GeneratedKeys[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_KEYS_RETURNED

public static final GeneratedKeys NO_KEYS_RETURNED

Specifies that a normal Statement.executeUpdate(java.lang.String) should be performed.

RETURNED_KEYS_DRIVER_DEFINED

public static final GeneratedKeys RETURNED_KEYS_DRIVER_DEFINED

Specifies that the JDBC driver should return whatever keys it decides to. This is the equivalent of Statement.executeUpdate(String sql, Statement.RETURN_GENERATED_KEYS)

RETURNED_KEYS_COLUMNS_SPECIFIED

public static final GeneratedKeys RETURNED_KEYS_COLUMNS_SPECIFIED

This specifies that the generated keys should be explicidly requested from the JDBC driver by name. This is the equivalent of Statement.executeUpdate(String sql, String [] colNames)

Method Detail

values

public static GeneratedKeys[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GeneratedKeys c : GeneratedKeys.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GeneratedKeys valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null