net.sf.mmm.util.date.api

Enum Month

java.lang.Object

java.lang.Enum<Month>

net.sf.mmm.util.date.api.Month

All Implemented Interfaces:

Serializable, Comparable<Month>, AttributeReadValue<Integer>, Datatype, SimpleDatatype<Integer>

public enum Month
extends Enum<Month>
implements SimpleDatatype<Integer>

The enum contains the twelve months of a year in Gregorian calendar.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Enum Constant Summary

Enum Constants

Enum Constant and Description
APRIL The according month.
AUGUST The according month.
DECEMBER The according month.
FEBRUARY The according month.
JANUARY The according month.
JULY The according month.
JUNE The according month.
MARCH The according month.
MAY The according month.
NOVEMBER The according month.
OCTOBER The according month.
SEPTEMBER The according month.

Field Summary

Fields

Modifier and Type	Field and Description
private String	title
private Integer	value

Method Summary

Modifier and Type	Method and Description
static Month	fromDate(Date date) This method gets the Month from the given date.
static Month	fromValue(Integer value) This method gets the DateUnit for the given value.
int	getMaxDays() This method gets the maximum number of days in this Month.
int	getMinDays() This method gets the minimum number of days in this Month.
Integer	getValue() This method returns the raw value of this datatype.
String	toString() Returns the official String representation of this Datatype.
static Month	valueOf(String name) Returns the enum constant of this type with the specified name.
static Month[]	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

JANUARY

public static final Month JANUARY

The according month.

FEBRUARY

public static final Month FEBRUARY

The according month.

MARCH

public static final Month MARCH

The according month.

APRIL

public static final Month APRIL

The according month.

MAY

public static final Month MAY

The according month.

JUNE

public static final Month JUNE

The according month.

JULY

public static final Month JULY

The according month.

AUGUST

public static final Month AUGUST

The according month.

SEPTEMBER

public static final Month SEPTEMBER

The according month.

OCTOBER

public static final Month OCTOBER

The according month.

NOVEMBER

public static final Month NOVEMBER

The according month.

DECEMBER

public static final Month DECEMBER

The according month.

Field Detail

value

private final Integer value

title

private final String title

Method Detail

values

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

Returns:

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

valueOf

public static Month 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 Integer getValue()

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.). ATTENTION:
Unlike java Calendar this will return the natural representation of a Month in the range from 1-12.

Specified by:

getValue in interface AttributeReadValue<Integer>

Specified by:

getValue in interface SimpleDatatype<Integer>

Returns:

the value of this datatype.

getMaxDays

public int getMaxDays()

This method gets the maximum number of days in this Month.

Returns:

the maximum number of days (29, 30, or 31).

getMinDays

public int getMinDays()

This method gets the minimum number of days in this Month.

Returns:

the minimum number of days (28, 30, or 31).

fromValue

public static Month fromValue(Integer 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.

fromDate

public static Month fromDate(Date date)

This method gets the Month from the given date.

Parameters:

date - is the Date.

Returns:

the Month of the given Date.

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<Month>

Returns:

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