net.sf.mpxj

Enum RecurrenceType

java.lang.Object

java.lang.Enum<RecurrenceType>

net.sf.mpxj.RecurrenceType

All Implemented Interfaces:

Serializable, Comparable<RecurrenceType>, MpxjEnum

public enum RecurrenceType
extends Enum<RecurrenceType>
implements MpxjEnum

Represents the recurrence type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAILY
MONTHLY
WEEKLY
YEARLY

Method Summary

Methods

Modifier and Type	Method and Description
static RecurrenceType	getInstance(int 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 RecurrenceType	valueOf(String name) Returns the enum constant of this type with the specified name.
static RecurrenceType[]	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 RecurrenceType DAILY

WEEKLY

public static final RecurrenceType WEEKLY

MONTHLY

public static final RecurrenceType MONTHLY

YEARLY

public static final RecurrenceType YEARLY

Method Detail

values

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

Returns:

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

valueOf

public static RecurrenceType 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 RecurrenceType getInstance(int 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<RecurrenceType>