com.im.df.api.ddl
Enum DFField.Required

java.lang.Object
  java.lang.Enum<DFField.Required>
      com.im.df.api.ddl.DFField.Required

All Implemented Interfaces:

Serializable, Comparable<DFField.Required>

Enclosing interface:

DFField

public static enum DFField.Required
extends Enum<DFField.Required>

Enumeration of required status for fields. AUTO means the value is automatically generated (e.g a primary key or chemical terms) and does not need to be provided by the user.

Enum Constant Summary

AUTO

FALSE

TRUE

Method Summary

FieldInfo.Required	getFieldInfoConstant() Return corresponding constant from IJC Server API.
static DFField.Required	valueOf(String name) Returns the enum constant of this type with the specified name.
static DFField.Required[]	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

FALSE

public static final DFField.Required FALSE

TRUE

public static final DFField.Required TRUE

AUTO

public static final DFField.Required AUTO

Method Detail

values

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

Returns:

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

valueOf

public static DFField.Required 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

getFieldInfoConstant

public FieldInfo.Required getFieldInfoConstant()

Return corresponding constant from IJC Server API.