net.sf.mmm.util.date.api

Enum Weekday

java.lang.Object

java.lang.Enum<Weekday>

net.sf.mmm.util.date.api.Weekday

All Implemented Interfaces:

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

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

The enum contains the seven days of a week in Gregorian calendar.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Enum Constant Summary

Enum Constants

Enum Constant and Description
FRIDAY The according weekday.
MONDAY The according weekday.
SATURDAY The according weekday.
SUNDAY The according weekday.
THURSDAY The according weekday.
TUESDAY The according weekday.
WEDNESDAY The according weekday.

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
Weekday	add(int days) This method returns the Weekday resulting if the given number of days are elapsed after the current Weekday (this).
static Weekday	fromCalendar(Calendar calendar) This method gets the Weekday from the given calendar.
static Weekday	fromCalendarId(int calendarId) This method gets the Weekday from the given calendar.
static Weekday	fromValue(String value) This method gets the Weekday for the given value.
int	getCalendarId() This method gets the ID constant of Calendar representing this Weekday.
Weekday	getNext() This method gets the next Weekday for this Weekday.
Weekday	getPrevious() This method gets the previous Weekday for this Weekday.
String	getValue() This method returns the raw value of this datatype.
void	setWeekday(Calendar calendar) This method sets this Weekday in the given calendar.
String	toString() Returns the official String representation of this Datatype.
static Weekday	valueOf(String name) Returns the enum constant of this type with the specified name.
static Weekday[]	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

MONDAY

public static final Weekday MONDAY

The according weekday.

TUESDAY

public static final Weekday TUESDAY

The according weekday.

WEDNESDAY

public static final Weekday WEDNESDAY

The according weekday.

THURSDAY

public static final Weekday THURSDAY

The according weekday.

FRIDAY

public static final Weekday FRIDAY

The according weekday.

SATURDAY

public static final Weekday SATURDAY

The according weekday.

SUNDAY

public static final Weekday SUNDAY

The according weekday.

Field Detail

value

private final String value

title

private final String title

calendarId

private final int calendarId

Method Detail

values

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

Returns:

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

valueOf

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

getNext

public Weekday getNext()

This method gets the next Weekday for this Weekday.

Returns:

the Weekday one day after this Weekday.

getPrevious

public Weekday getPrevious()

This method gets the previous Weekday for this Weekday.

Returns:

the Weekday one day before this Weekday.

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.

setWeekday

public void setWeekday(Calendar calendar)

This method sets this Weekday in the given calendar.

Parameters:

calendar - is the Calendar.

getCalendarId

public int getCalendarId()

This method gets the ID constant of Calendar representing this Weekday. This is the Christian representation where SUNDAY is the first day of the week represented with 1. The enum constants of Weekday are ordered such that MONDAY comes first, so you can use Enum.ordinal() for other representation. Please note that Enum.ordinal() is 0 based so you might want to increment the result.

Returns:

the calendar ID.

add

public Weekday add(int days)

This method returns the Weekday resulting if the given number of days are elapsed after the current Weekday (this). The Weekday will wrap so add(7) will return the Weekday itself (this) just like add(0) or e.g. add(-14).

Parameters:

days - are the number of days to add. May be negative to subtract or zero (0) for no change.

Returns:

the resulting Weekday.

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

Returns:

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

fromValue

public static Weekday fromValue(String value)

This method gets the Weekday for the given value.

Parameters:

value - is the value of the requested Weekday.

Returns:

the requested Weekday or null if no such Weekday exists.

fromCalendar

public static Weekday fromCalendar(Calendar calendar)

This method gets the Weekday from the given calendar.

Parameters:

calendar - is the Calendar.

Returns:

the Weekday representing the weekday of the given Calendar.

fromCalendarId

public static Weekday fromCalendarId(int calendarId)

This method gets the Weekday from the given calendar.

Parameters:

calendarId - is the calendar ID.

Returns:

the Weekday representing the calendar ID or null if no such Weekday exists (illegal calendarId).