net.sf.mpxj

Enum RelationType

java.lang.Object

java.lang.Enum<RelationType>

net.sf.mpxj.RelationType

All Implemented Interfaces:

Serializable, Comparable<RelationType>, MpxjEnum

public enum RelationType
extends Enum<RelationType>
implements MpxjEnum

This class is used to represent a relation type. It provides a mapping between the textual description of a relation type found in an MPX file, and an enumerated representation that can be more easily manipulated programmatically.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FINISH_FINISH
FINISH_START
START_FINISH
START_START

Method Summary

Modifier and Type	Method and Description
static RelationType	getInstance(int type) Retrieve an instance of the enum based on its int value.
static RelationType	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()
static RelationType	valueOf(String name) Returns the enum constant of this type with the specified name.
static RelationType[]	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

FINISH_FINISH

public static final RelationType FINISH_FINISH

FINISH_START

public static final RelationType FINISH_START

START_FINISH

public static final RelationType START_FINISH

START_START

public static final RelationType START_START

Method Detail

values

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

Returns:

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

valueOf

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

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

Parameters:

type - int type

Returns:

enum instance

getInstance

public static RelationType 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()

Overrides:

toString in class Enum<RelationType>