org.hibernate.jpa

Enum SchemaGenAction

java.lang.Object

java.lang.Enum<SchemaGenAction>

org.hibernate.jpa.SchemaGenAction

All Implemented Interfaces:

Serializable, Comparable<SchemaGenAction>

public enum SchemaGenAction
extends Enum<SchemaGenAction>

Describes the allowable values of the and AvailableSettings.SCHEMA_GEN_SCRIPTS_ACTION settings.

See Also:

AvailableSettings.SCHEMA_GEN_DATABASE_ACTION, AvailableSettings.SCHEMA_GEN_SCRIPTS_ACTION

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH "drop-and-create" - both database creation and database dropping will be generated.
CREATE "create" - database creation will be generated
DROP "drop" - database dropping will be generated
NONE "none" - no actions will be performed (aka, generation is disabled).

Method Summary

Modifier and Type	Method and Description
boolean	includesCreate() Does this action include creations?
boolean	includesDrop() Does this action include drops?
static SchemaGenAction	interpret(Object value) Used when processing JPA configuration to interpret the user config values.
String	toString()
static SchemaGenAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static SchemaGenAction[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final SchemaGenAction NONE

"none" - no actions will be performed (aka, generation is disabled).

CREATE

public static final SchemaGenAction CREATE

"create" - database creation will be generated

DROP

public static final SchemaGenAction DROP

"drop" - database dropping will be generated

BOTH

public static final SchemaGenAction BOTH

"drop-and-create" - both database creation and database dropping will be generated.

Method Detail

values

public static SchemaGenAction[] 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 (SchemaGenAction c : SchemaGenAction.values())
    System.out.println(c);

Returns:

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

valueOf

public static SchemaGenAction 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

interpret

public static SchemaGenAction interpret(Object value)

Used when processing JPA configuration to interpret the user config values.

Parameters:

value - The encountered config value

Returns:

The matching enum value. An empty value will return NONE.

Throws:

IllegalArgumentException - If the incoming value is unrecognized

includesCreate

public boolean includesCreate()

Does this action include creations?

Returns:

true if this action is either CREATE or BOTH

includesDrop

public boolean includesDrop()

Does this action include drops?

Returns:

true if this action is either DROP or BOTH

toString

public String toString()

Overrides:

toString in class Enum<SchemaGenAction>