net.sf.mpxj
Enum ScheduleFrom

java.lang.Object
  java.lang.Enum<ScheduleFrom>
      net.sf.mpxj.ScheduleFrom

All Implemented Interfaces:

Serializable, Comparable<ScheduleFrom>, MpxjEnum

public enum ScheduleFrom
extends Enum<ScheduleFrom>
implements MpxjEnum

Instances of this class represent enumerated schedule from values.

Enum Constant Summary

FINISH

START

Method Summary

static ScheduleFrom	getInstance(int type) Retrieve an instance of the enum based on its int value.
static ScheduleFrom	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 schedule from type to be used as part of an MPX file.
static ScheduleFrom	valueOf(String name) Returns the enum constant of this type with the specified name.
static ScheduleFrom[]	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

START

public static final ScheduleFrom START

FINISH

public static final ScheduleFrom FINISH

Method Detail

values

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

Returns:

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

valueOf

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

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

Parameters:

type - int type

Returns:

enum instance

getInstance

public static ScheduleFrom 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 schedule from type to be used as part of an MPX file.

Overrides:

toString in class Enum<ScheduleFrom>

Returns:

string representation