net.sf.mpxj
Enum AccrueType

java.lang.Object
  extended by java.lang.Enum<AccrueType>
      extended by net.sf.mpxj.AccrueType
All Implemented Interfaces:
Serializable, Comparable<AccrueType>, MpxjEnum

public enum AccrueType
extends Enum<AccrueType>
implements MpxjEnum

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


Enum Constant Summary
END
           
PRORATED
           
START
           
 
Method Summary
static AccrueType getInstance(int type)
          Retrieve an instance of the enum based on its int value.
static AccrueType 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.
static AccrueType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static AccrueType[] 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

START

public static final AccrueType START

END

public static final AccrueType END

PRORATED

public static final AccrueType PRORATED
Method Detail

values

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

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

valueOf

public static AccrueType 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 AccrueType getInstance(int type)
Retrieve an instance of the enum based on its int value.

Parameters:
type - int type
Returns:
enum instance

getInstance

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


Copyright © 2012. All Rights Reserved.