net.sf.mpxj.mpp

Enum ProgressLineDay

java.lang.Object

java.lang.Enum<ProgressLineDay>

net.sf.mpxj.mpp.ProgressLineDay

All Implemented Interfaces:

Serializable, Comparable<ProgressLineDay>, MpxjEnum

public enum ProgressLineDay
extends Enum<ProgressLineDay>
implements MpxjEnum

Instances of this class represent enumerated day values used as to define when progress lines are drawn.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAY
FRIDAY
MONDAY
NONWORKINGDAY
SATURDAY
SUNDAY
THURSDAY
TUESDAY
WEDNESDAY
WORKINGDAY

Method Summary

Methods

Modifier and Type	Method and Description
Day	getDay() Retrieve the Day instance which is equivalent to this ProgressLine.
static ProgressLineDay	getInstance(int type) Retrieve a ProgressLineDay instance representing the supplied value.
ProgressLineDay	getNextDay() This method provides a simple mechanism to retrieve the next day in correct sequence, including the transition from Sunday to Monday.
int	getValue() Retrieves the int representation of the day.
static ProgressLineDay	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProgressLineDay[]	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

SUNDAY

public static final ProgressLineDay SUNDAY

MONDAY

public static final ProgressLineDay MONDAY

TUESDAY

public static final ProgressLineDay TUESDAY

WEDNESDAY

public static final ProgressLineDay WEDNESDAY

THURSDAY

public static final ProgressLineDay THURSDAY

FRIDAY

public static final ProgressLineDay FRIDAY

SATURDAY

public static final ProgressLineDay SATURDAY

DAY

public static final ProgressLineDay DAY

WORKINGDAY

public static final ProgressLineDay WORKINGDAY

NONWORKINGDAY

public static final ProgressLineDay NONWORKINGDAY

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Retrieves the int representation of the day.

Specified by:

getValue in interface MpxjEnum

Returns:

task type value

getDay

public Day getDay()

Retrieve the Day instance which is equivalent to this ProgressLine.

Returns:

Day instance

getNextDay

public ProgressLineDay getNextDay()

This method provides a simple mechanism to retrieve the next day in correct sequence, including the transition from Sunday to Monday.

Returns:

ProgressLineDay instance

getInstance

public static ProgressLineDay getInstance(int type)

Retrieve a ProgressLineDay instance representing the supplied value.

Parameters:

type - type value

Returns:

ProgressLineDay instance