Package com.apptus.esales.connector.time

Enum Unit

java.lang.Object

java.lang.Enum<Unit>

com.apptus.esales.connector.time.Unit

All Implemented Interfaces:

Serializable, Comparable<Unit>

public enum Unit
extends Enum<Unit>

An enumeration of time units.

Author:

Thomas Raneland, Robert Åkemalm

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAY
HOUR
MINUTE
MONTH
SECOND
WEEK
YEAR

Method Summary

Modifier and Type	Method	Description
void	add(Calendar cal, int amount)	Moves a calendar amount units in time.
void	ceil(Calendar cal)	Moves the calendar time forwards to the closest whole unit.
String	displayName(Calendar cal)
void	floor(Calendar cal)	Moves the calendar time backwards to the closest whole unit.
static Unit	forSymbol(String symbol)
void	round(Calendar cal)	Moves the calendar time to the closest whole unit.
String	symbol()
static Unit	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Unit[]	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

SECOND

public static final Unit SECOND

MINUTE

public static final Unit MINUTE

HOUR

public static final Unit HOUR

DAY

public static final Unit DAY

WEEK

public static final Unit WEEK

MONTH

public static final Unit MONTH

YEAR

public static final Unit YEAR

Method Detail

values

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

Returns:

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

valueOf

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

displayName

public String displayName(Calendar cal)

Parameters:

cal - The calendar to get the string representation for.

Returns:

A string representation of the calendar time presented in a simplified format.

add

public void add(Calendar cal,
                int amount)

Moves a calendar amount units in time. Use a positive amount to move forward and a negative amount to move backwards.

Parameters:

cal - The calendar to change time for.

amount - The number of units to move the time of the calendar.

floor

public void floor(Calendar cal)

Moves the calendar time backwards to the closest whole unit. Will not change the calendar if the time is already floored,

Parameters:

cal - The calendar to floor.

ceil

public void ceil(Calendar cal)

Moves the calendar time forwards to the closest whole unit. Will not change the calendar if the time is already ceiled,

Parameters:

cal - The calendar to ceil.

round

public void round(Calendar cal)

Moves the calendar time to the closest whole unit. Will not change the calendar if the time is already at the start of a unit,

Parameters:

cal - The calendar to round.

symbol

public String symbol()

Returns:

A string representation of the unit.

forSymbol

public static Unit forSymbol(String symbol)
                      throws UnknownUnitException

Parameters:

symbol - A string representation of the unit.

Returns:

The unit associated with the symbol.

Throws:

UnknownUnitException - If no unit is associated with the symbol.