net.sf.mpxj

Enum ConstraintField

java.lang.Object

java.lang.Enum<ConstraintField>

net.sf.mpxj.ConstraintField

All Implemented Interfaces:

Serializable, Comparable<ConstraintField>, FieldType, MpxjEnum

public enum ConstraintField
extends Enum<ConstraintField>
implements FieldType

Instances of this type represent constraint fields.

Enum Constant Summary

Enum Constants

Enum Constant and Description
TASK1
TASK2
UNIQUE_ID

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_VALUE

Method Summary

Modifier and Type	Method and Description
DataType	getDataType() Retrieve the data type of this field.
FieldTypeClass	getFieldTypeClass() Retrieve an enum representing the type of entity to which this field belongs.
static ConstraintField	getInstance(int type) This method takes the integer enumeration of a constraint field and returns an appropriate class instance.
String	getName() Retrieve the name of this field using the default locale.
String	getName(Locale locale) Retrieve the name of this field using the supplied locale.
FieldType	getUnitsType() Retrieve the associated units field, if any.
int	getValue() This method is used to retrieve the int value (not the ordinal) associated with an enum instance.
String	toString() Retrieves the string representation of this instance.
static ConstraintField	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConstraintField[]	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

Methods inherited from interface net.sf.mpxj.FieldType

name

Enum Constant Detail

UNIQUE_ID

public static final ConstraintField UNIQUE_ID

TASK1

public static final ConstraintField TASK1

TASK2

public static final ConstraintField TASK2

Field Detail

MAX_VALUE

public static final int MAX_VALUE

Method Detail

values

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

Returns:

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

valueOf

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

getFieldTypeClass

public FieldTypeClass getFieldTypeClass()

Description copied from interface: FieldType

Retrieve an enum representing the type of entity to which this field belongs.

Specified by:

getFieldTypeClass in interface FieldType

Returns:

field type class

getName

public String getName()

Description copied from interface: FieldType

Retrieve the name of this field using the default locale.

Specified by:

getName in interface FieldType

Returns:

field name

getName

public String getName(Locale locale)

Description copied from interface: FieldType

Retrieve the name of this field using the supplied locale.

Specified by:

getName in interface FieldType

Parameters:

locale - target locale

Returns:

field name

getValue

public int getValue()

Description copied from interface: MpxjEnum

This method is used to retrieve the int value (not the ordinal) associated with an enum instance.

Specified by:

getValue in interface MpxjEnum

Returns:

enum value

getDataType

public DataType getDataType()

Description copied from interface: FieldType

Retrieve the data type of this field.

Specified by:

getDataType in interface FieldType

Returns:

data type

getUnitsType

public FieldType getUnitsType()

Description copied from interface: FieldType

Retrieve the associated units field, if any.

Specified by:

getUnitsType in interface FieldType

Returns:

units field

toString

public String toString()

Retrieves the string representation of this instance.

Overrides:

toString in class Enum<ConstraintField>

Returns:

string representation

getInstance

public static ConstraintField getInstance(int type)

This method takes the integer enumeration of a constraint field and returns an appropriate class instance.

Parameters:

type - integer constraint field enumeration

Returns:

ConstraintField instance