net.sf.mpxj

Enum ProjectTimeFormat

java.lang.Object

java.lang.Enum<ProjectTimeFormat>

net.sf.mpxj.ProjectTimeFormat

All Implemented Interfaces:

Serializable, Comparable<ProjectTimeFormat>, MpxjEnum

public enum ProjectTimeFormat
extends Enum<ProjectTimeFormat>
implements MpxjEnum

Instances of this class represent enumerated time format values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
TWELVE_HOUR
TWENTY_FOUR_HOUR

Method Summary

Methods

Modifier and Type	Method and Description
static ProjectTimeFormat	getInstance(int type) Retrieve an instance of the enum based on its int value.
static ProjectTimeFormat	getInstance(Number type) Retrieve an instance of the enum based on its int value.
int	getValue() Accessor method used to retrieve the numeric representation of the enum.
String	toString() Returns a string representation of the time format type to be used as part of an MPX file.
static ProjectTimeFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProjectTimeFormat[]	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

Enum Constant Detail

TWELVE_HOUR

public static final ProjectTimeFormat TWELVE_HOUR

TWENTY_FOUR_HOUR

public static final ProjectTimeFormat TWENTY_FOUR_HOUR

Method Detail

values

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

Returns:

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

valueOf

public static ProjectTimeFormat 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 ProjectTimeFormat getInstance(int type)

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

Parameters:

type - int type

Returns:

enum instance

getInstance

public static ProjectTimeFormat getInstance(Number type)

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

Parameters:

type - int type

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

toString

public String toString()

Returns a string representation of the time format type to be used as part of an MPX file.

Overrides:

toString in class Enum<ProjectTimeFormat>

Returns:

string representation