Enum Jdbc2SchemaOptionName
- java.lang.Object
-
- java.lang.Enum<Jdbc2SchemaOptionName>
-
- org.apache.torque.templates.transformer.jdbc2schema.Jdbc2SchemaOptionName
-
- All Implemented Interfaces:
Serializable
,Comparable<Jdbc2SchemaOptionName>
,OptionName
public enum Jdbc2SchemaOptionName extends Enum<Jdbc2SchemaOptionName> implements OptionName
The option names which are used in the java code of the jdbc2schema templates. $Id: Jdbc2SchemaOptionName.java 1839288 2018-08-27 09:48:33Z tv $
-
-
Enum Constant Summary
Enum Constants Enum Constant Description DATABASE_NAME
The name of the database to generate.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static void
checkRequiredOptions(ControllerState controllerState)
Checks whether all required options are set.String
getName()
Returns the name of the option.boolean
isRequired()
Returns whether this option must be set.String
toString()
static Jdbc2SchemaOptionName
valueOf(String name)
Returns the enum constant of this type with the specified name.static Jdbc2SchemaOptionName[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
DATABASE_NAME
public static final Jdbc2SchemaOptionName DATABASE_NAME
The name of the database to generate.
-
-
Method Detail
-
values
public static Jdbc2SchemaOptionName[] 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 (Jdbc2SchemaOptionName c : Jdbc2SchemaOptionName.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Jdbc2SchemaOptionName 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 nameNullPointerException
- if the argument is null
-
getName
public String getName()
Returns the name of the option.- Specified by:
getName
in 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
public String toString()
- Overrides:
toString
in 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.
-
-