net.sf.mpxj.mpp

Enum Interval

java.lang.Object

java.lang.Enum<Interval>

net.sf.mpxj.mpp.Interval

All Implemented Interfaces:

Serializable, Comparable<Interval>, MpxjEnum

public enum Interval
extends Enum<Interval>
implements MpxjEnum

This class represents daily, weekly or monthly time intervals.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAILY
MONTHLY
WEEKLY

Method Summary

Modifier and Type	Method and Description
static Interval	getInstance(int type) Retrieve an instance of the enum based on its int value.
static Interval	getInstance(Number type) Retrieve an instance of the enum based on its int value.
String	getName() Retrieve the interval name.
int	getValue() Accessor method used to retrieve the numeric representation of the enum.
String	toString() Retrieve the String representation of this line style.
static Interval	valueOf(String name) Returns the enum constant of this type with the specified name.
static Interval[]	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

DAILY

public static final Interval DAILY

WEEKLY

public static final Interval WEEKLY

MONTHLY

public static final Interval MONTHLY

Method Detail

values

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

Returns:

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

valueOf

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

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

Parameters:

type - int type

Returns:

enum instance

getInstance

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

getName

public String getName()

Retrieve the interval name. Currently this is not localised.

Returns:

interval name

toString

public String toString()

Retrieve the String representation of this line style.

Overrides:

toString in class Enum<Interval>

Returns:

String representation of this line style