org.osivia.services.calendar.portlet.utils

Enum PeriodTypes

java.lang.Object

java.lang.Enum<PeriodTypes>

org.osivia.services.calendar.portlet.utils.PeriodTypes

All Implemented Interfaces:

Serializable, Comparable<PeriodTypes>

public enum PeriodTypes
extends Enum<PeriodTypes>

Calendar period types enumeration.

Author:

Cédric Krommenhoek

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAY Day.
MONTH Month.
PLANNING Planning.
WEEK Week.

Method Summary

Methods

Modifier and Type	Method and Description
static PeriodTypes	fromName(String name) Get period from his name.
int	getField() Getter for field.
String	getInternationalizationKey() Getter for internationalizationKey.
String	getName() Getter for name.
String	getViewPath() Getter for viewPath.
boolean	isCompactable() Getter for compactable.
static PeriodTypes	valueOf(String name) Returns the enum constant of this type with the specified name.
static PeriodTypes[]	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

DAY

public static final PeriodTypes DAY

Day.

WEEK

public static final PeriodTypes WEEK

Week.

MONTH

public static final PeriodTypes MONTH

Month.

PLANNING

public static final PeriodTypes PLANNING

Planning.

Method Detail

values

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

Returns:

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

valueOf

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

fromName

public static PeriodTypes fromName(String name)

Get period from his name.

Parameters:

name - period name

Returns:

period

getName

public String getName()

Getter for name.

Returns:

the name

getInternationalizationKey

public String getInternationalizationKey()

Getter for internationalizationKey.

Returns:

the internationalizationKey

getField

public int getField()

Getter for field.

Returns:

the field

getViewPath

public String getViewPath()

Getter for viewPath.

Returns:

the viewPath

isCompactable

public boolean isCompactable()

Getter for compactable.

Returns:

the compactable