net.sf.mmm.util.date.api

Enum DateUnit

java.lang.Object

java.lang.Enum<DateUnit>

net.sf.mmm.util.date.api.DateUnit

All Implemented Interfaces:

Serializable, Comparable<DateUnit>, AttributeReadValue<String>, Datatype, SimpleDatatype<String>

public enum DateUnit
extends Enum<DateUnit>
implements SimpleDatatype<String>

The enum contains the units of a date. These are DAY, WEEK, MONTH, and YEAR.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

TimeUnit

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAY The day of the month starting with 1.
MONTH The month of the year starting with 1 (NOT 0 like Calendar does).
WEEK The week (of the year) starting with 1.
YEAR The year.

Field Summary

Fields

Modifier and Type	Field and Description
private int	calendarId
private String	title
private String	value

Method Summary

Modifier and Type	Method and Description
static DateUnit	fromValue(String value) This method gets the DateUnit for the given value.
int	getCalendarField(Calendar calendar) This method delegates to Calendar.get(int).
int	getCalendarId() This method gets the ID constant for Calendar operations such as Calendar.get(int).
String	getValue() This method returns the raw value of this datatype.
void	setCalendarField(Calendar calendar, int unitValue) This method delegates to Calendar.set(int, int).
String	toString() Returns the official String representation of this Datatype.
static DateUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static DateUnit[]	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

DAY

public static final DateUnit DAY

The day of the month starting with 1.

WEEK

public static final DateUnit WEEK

The week (of the year) starting with 1.

MONTH

public static final DateUnit MONTH

The month of the year starting with 1 (NOT 0 like Calendar does).

See Also:

Month

YEAR

public static final DateUnit YEAR

The year.

Field Detail

value

private final String value

title

private final String title

calendarId

private final int calendarId

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public String getValue()

Description copied from interface: SimpleDatatype

This method returns the raw value of this datatype. This will typically be a standard datatype (like String , Character, Boolean, any type of Number, any type of java.time.LocalDate, etc.).

Specified by:

getValue in interface AttributeReadValue<String>

Specified by:

getValue in interface SimpleDatatype<String>

Returns:

the value of this datatype.

toString

public String toString()

Description copied from interface: Datatype

Returns the official String representation of this Datatype. While the general contract of Object.toString() is very weak and mainly used for debugging, the contract here is very strong. The returned String has to be suitable for end-users and official output to any kind of sink.
ATTENTION:
This method is not supposed to do internationalization (I18N). See NlsMessage for this purpose and implement NlsObject if you want to support I18N/L10N.

Specified by:

toString in interface Datatype

Overrides:

toString in class Enum<DateUnit>

Returns:

the official String representation to display the value of this Datatype.

getCalendarField

public int getCalendarField(Calendar calendar)

This method delegates to Calendar.get(int). However, it will return the month in a natural way from 1 to 12. Java Calendar returns 0 for January instead of 1 and so forth what is the cause of many mistakes.

Parameters:

calendar - is the Calendar.

Returns:

the requested calendar field for this DateUnit.

setCalendarField

public void setCalendarField(Calendar calendar,
                             int unitValue)

This method delegates to Calendar.set(int, int). However, it will treat the month in a natural way from 1 to 12. Java Calendar expects 0 for January instead of 1 and so forth what is the cause of many mistakes.

Parameters:

calendar - is the Calendar.

unitValue - is the value to set.

getCalendarId

public int getCalendarId()

This method gets the ID constant for Calendar operations such as Calendar.get(int).

Returns:

the calendar ID.

fromValue

public static DateUnit fromValue(String value)

This method gets the DateUnit for the given value.

Parameters:

value - is the value of the requested DateUnit.

Returns:

the requested DateUnit or null if no such DateUnit exists.