Enum Class Jdbc2SchemaOptionName
java.lang.Object
java.lang.Enum<Jdbc2SchemaOptionName>
org.apache.torque.templates.transformer.jdbc2schema.Jdbc2SchemaOptionName
- All Implemented Interfaces:
Serializable,Comparable<Jdbc2SchemaOptionName>,Constable,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 $
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionstatic voidcheckRequiredOptions(ControllerState controllerState) Checks whether all required options are set.getName()Returns the name of the option.booleanReturns whether this option must be set.toString()static Jdbc2SchemaOptionNameReturns the enum constant of this class with the specified name.static Jdbc2SchemaOptionName[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
DATABASE_NAME
The name of the database to generate.
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
getName
Returns the name of the option.- Specified by:
getNamein interfaceOptionName- Returns:
- the fully qualified name of the option, not null.
-
isRequired
public boolean isRequired()Returns whether this option must be set.- Returns:
- true if the option must be set, false if it may be set.
-
toString
- Overrides:
toStringin classEnum<Jdbc2SchemaOptionName>
-
checkRequiredOptions
public static void checkRequiredOptions(ControllerState controllerState) throws SourceTransformerException Checks whether all required options are set.- Parameters:
controllerState- the current controller state, not null.- Throws:
SourceTransformerException- if a required option is not set.
-