org.cyclos.model.utils

Enum PeriodType

java.lang.Object

java.lang.Enum<PeriodType>

org.cyclos.model.utils.PeriodType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PeriodType>

public enum PeriodType
extends java.lang.Enum<PeriodType>

A type of period

Author:

rinke

Enum Constant Summary

Enum Constants

Enum Constant and Description
CURRENT_DAY The current day
CURRENT_WEEK The current week
DAY A full day
MONTH A full month
MONTH_RANGE A month range, such as last 6 months
QUARTER A quarter
WEEK_OF_YEAR A week of the year
YEAR A full year

Method Summary

Modifier and Type	Method and Description
Pair<java.lang.Integer,java.lang.Integer>	getBoundaries()
java.lang.Integer	getLowerBoundary()
java.lang.Integer	getUpperBoundary()
static PeriodType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PeriodType[]	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

YEAR

public static final PeriodType YEAR

A full year

QUARTER

public static final PeriodType QUARTER

A quarter

MONTH

public static final PeriodType MONTH

A full month

MONTH_RANGE

public static final PeriodType MONTH_RANGE

A month range, such as last 6 months

WEEK_OF_YEAR

public static final PeriodType WEEK_OF_YEAR

A week of the year

DAY

public static final PeriodType DAY

A full day

CURRENT_WEEK

public static final PeriodType CURRENT_WEEK

The current week

CURRENT_DAY

public static final PeriodType CURRENT_DAY

The current day

Method Detail

values

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

Returns:

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

valueOf

public static PeriodType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getBoundaries

public Pair<java.lang.Integer,java.lang.Integer> getBoundaries()

getLowerBoundary

public java.lang.Integer getLowerBoundary()

getUpperBoundary

public java.lang.Integer getUpperBoundary()