net.sf.mmm.util.date.api

Enum WeekOfMonth

java.lang.Object

java.lang.Enum<WeekOfMonth>

net.sf.mmm.util.date.api.WeekOfMonth

All Implemented Interfaces:

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

public enum WeekOfMonth
extends Enum<WeekOfMonth>
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
FIRST The according month.
FOURTH The according month.
LAST The according month.
SECOND The according month.
THIRD 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 WeekOfMonth	fromValue(Integer value) This method gets the WeekOfMonth for the given value.
Integer	getValue() This method returns the raw value of this datatype.
String	toString() Returns the official String representation of this Datatype.
static WeekOfMonth	valueOf(String name) Returns the enum constant of this type with the specified name.
static WeekOfMonth[]	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

FIRST

public static final WeekOfMonth FIRST

The according month.

SECOND

public static final WeekOfMonth SECOND

The according month.

THIRD

public static final WeekOfMonth THIRD

The according month.

FOURTH

public static final WeekOfMonth FOURTH

The according month.

LAST

public static final WeekOfMonth LAST

The according month.

Field Detail

value

private final Integer value

title

private final String title

Method Detail

values

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

Returns:

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

valueOf

public static WeekOfMonth 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()

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

Specified by:

getValue in interface SimpleDatatype<Integer>

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

Returns:

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

fromValue

public static WeekOfMonth fromValue(Integer value)

This method gets the WeekOfMonth for the given value.

Parameters:

value - is the value of the requested WeekOfMonth.

Returns:

the requested WeekOfMonth or null if no such WeekOfMonth exists.