org.mpxj

Enum CustomFieldValueDataType

java.lang.Object

java.lang.Enum<CustomFieldValueDataType>

org.mpxj.CustomFieldValueDataType

All Implemented Interfaces:

Serializable, Comparable<CustomFieldValueDataType>, MpxjEnum

public enum CustomFieldValueDataType
extends Enum<CustomFieldValueDataType>
implements MpxjEnum

Enumeration used by custom field value items to represent their data type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COST
DATE
DURATION
FINISH_DATE
FLAG
NUMBER
TEXT

Method Summary

Modifier and Type	Method and Description
DataType	getDataType() Retrieve the MPXJ data type.
static CustomFieldValueDataType	getInstance(int type) Retrieve an instance of the enum based on its int value.
static CustomFieldValueDataType	getInstanceByMaskValue(int type) Retrieve an instance of the enum based on its mask value.
int	getMaskValue() Retrieve the mask value.
int	getValue() Accessor method used to retrieve the numeric representation of the enum.
static CustomFieldValueDataType	valueOf(String name) Returns the enum constant of this type with the specified name.
static CustomFieldValueDataType[]	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

DATE

public static final CustomFieldValueDataType DATE

DURATION

public static final CustomFieldValueDataType DURATION

COST

public static final CustomFieldValueDataType COST

NUMBER

public static final CustomFieldValueDataType NUMBER

FLAG

public static final CustomFieldValueDataType FLAG

TEXT

public static final CustomFieldValueDataType TEXT

FINISH_DATE

public static final CustomFieldValueDataType FINISH_DATE

Method Detail

values

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

Returns:

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

valueOf

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

getInstance

public static CustomFieldValueDataType getInstance(int type)

Retrieve an instance of the enum based on its int value.

Parameters:

type - int type

Returns:

enum instance

getInstanceByMaskValue

public static CustomFieldValueDataType getInstanceByMaskValue(int type)

Retrieve an instance of the enum based on its mask value.

Parameters:

type - mask value

Returns:

enum instance

getValue

public int getValue()

Accessor method used to retrieve the numeric representation of the enum.

Specified by:

getValue in interface MpxjEnum

Returns:

int representation of the enum

getDataType

public DataType getDataType()

Retrieve the MPXJ data type.

Returns:

MPXJ data type

getMaskValue

public int getMaskValue()

Retrieve the mask value.

Returns:

mask value