Enum ColumnProperty
- java.lang.Object
-
- java.lang.Enum<ColumnProperty>
-
- com.inductiveautomation.ignition.common.db.schema.ColumnProperty
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ColumnProperty>
public enum ColumnProperty extends java.lang.Enum<ColumnProperty>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AutoIncrement
The column should be either auto-incrementing, or linked to a sequence through a trigger, depending on the db.Indexed
Creates a separate index for the column.NotNull
PrimaryKey
The primary key of the table.Unique
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static ColumnProperty
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static ColumnProperty[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
Indexed
public static final ColumnProperty Indexed
Creates a separate index for the column.
-
NotNull
public static final ColumnProperty NotNull
-
AutoIncrement
public static final ColumnProperty AutoIncrement
The column should be either auto-incrementing, or linked to a sequence through a trigger, depending on the db.
-
Unique
public static final ColumnProperty Unique
-
PrimaryKey
public static final ColumnProperty PrimaryKey
The primary key of the table. Implies that it will be indexed. NOTE: Combining PrimaryKey with Indexed will result in multiple indexes on the column. Multiple columns can be used as the primary key.
-
-
Method Detail
-
values
public static ColumnProperty[] 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 (ColumnProperty c : ColumnProperty.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ColumnProperty valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-