net.sf.mpxj.mpp
Enum TimescaleUnits

java.lang.Object
  java.lang.Enum<TimescaleUnits>
      net.sf.mpxj.mpp.TimescaleUnits

All Implemented Interfaces:

Serializable, Comparable<TimescaleUnits>, MpxjEnum

public enum TimescaleUnits
extends Enum<TimescaleUnits>
implements MpxjEnum

Class representing the units which may be shown on a Gantt chart timescale.

Enum Constant Summary

DAYS

HALF_YEARS

HOURS

MINUTES

MONTHS

NONE

QUARTERS

THIRDS_OF_MONTHS

WEEKS

YEARS

Method Summary

static TimescaleUnits	getInstance(int type) Retrieve an instance of the enum based on its int value.
static TimescaleUnits	getInstance(Number type) Retrieve an instance of the enum based on its int value.
String	getName() Retrieve the name of this time unit.
int	getValue() Accessor method used to retrieve the numeric representation of the enum.
String	toString() Generate a string representation of this instance.
static TimescaleUnits	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimescaleUnits[]	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

NONE

public static final TimescaleUnits NONE

MINUTES

public static final TimescaleUnits MINUTES

HOURS

public static final TimescaleUnits HOURS

DAYS

public static final TimescaleUnits DAYS

WEEKS

public static final TimescaleUnits WEEKS

THIRDS_OF_MONTHS

public static final TimescaleUnits THIRDS_OF_MONTHS

MONTHS

public static final TimescaleUnits MONTHS

QUARTERS

public static final TimescaleUnits QUARTERS

HALF_YEARS

public static final TimescaleUnits HALF_YEARS

YEARS

public static final TimescaleUnits YEARS

Method Detail

values

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

Returns:

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

valueOf

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

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

Parameters:

type - int type

Returns:

enum instance

getInstance

public static TimescaleUnits 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 name of this time unit. Note that this is not localised.

Returns:

name of this timescale unit

toString

public String toString()

Generate a string representation of this instance.

Overrides:

toString in class Enum<TimescaleUnits>

Returns:

string representation of this instance