net.sf.mmm.util.date.base

Class RecurrenceBean

java.lang.Object

net.sf.mmm.util.date.base.RecurrenceBean

All Implemented Interfaces:

Recurrence

public class RecurrenceBean
extends Object
implements Recurrence

This is the implementation of Recurrence as simple Java Bean.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private int	step
private DateUnit	unit
private WeekdaySet	weekdays
private WeekOfMonth	weekOfMonth

Constructor Summary

Constructors

Constructor and Description
RecurrenceBean() The constructor.
RecurrenceBean(DateUnit unit, int step, WeekdaySet weekdays, WeekOfMonth weekOfMonth) The constructor.

Method Summary

Modifier and Type	Method and Description
int	getStep() This method gets the step of this Recurrence.
DateUnit	getUnit() This method gets the DateUnit of this Recurrence.
WeekdaySet	getWeekdays() This method gets the WeekdaySet containing the Weekdays of the recurrence.
WeekOfMonth	getWeekOfMonth() This method gets the WeekOfMonth of a monthly or yearly recurrence.
void	setStep(int step)
void	setUnit(DateUnit unit)
void	setWeekdays(WeekdaySet weekdays)
void	setWeekOfMonth(WeekOfMonth weekOfMonth)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

unit

private DateUnit unit

step

private int step

weekdays

private WeekdaySet weekdays

weekOfMonth

private WeekOfMonth weekOfMonth

Constructor Detail

RecurrenceBean

public RecurrenceBean()

The constructor.

RecurrenceBean

public RecurrenceBean(DateUnit unit,
                      int step,
                      WeekdaySet weekdays,
                      WeekOfMonth weekOfMonth)

The constructor.

Parameters:

unit - - see getUnit().

step - - see getStep().

weekdays - - see getWeekdays().

weekOfMonth - - see getWeekOfMonth().

Method Detail

getUnit

public DateUnit getUnit()

Description copied from interface: Recurrence

This method gets the DateUnit of this Recurrence.

Specified by:

getUnit in interface Recurrence

Returns:

the DateUnit.

See Also:

Recurrence.getStep()

setUnit

public void setUnit(DateUnit unit)

Parameters:

unit - is the unit to set.

getStep

public int getStep()

Description copied from interface: Recurrence

This method gets the step of this Recurrence. The Recurrence will happen every step units (e.g. every day or every 2 weeks). The returned value has to be greater or equal to 1.

Specified by:

getStep in interface Recurrence

Returns:

the step.

setStep

public void setStep(int step)

Parameters:

step - is the step to set.

getWeekdays

public WeekdaySet getWeekdays()

Description copied from interface: Recurrence

This method gets the WeekdaySet containing the Weekdays of the recurrence. This is used as a filter to match only for particular Weekdays. The default is WeekdaySet.ALL. This method is ignored for weekly Recurrence as it would NOT make any sense.
ATTENTION:
If unit is daily recurrences that do not match will be omitted, while otherwise the closest match will be used. If it is monthly or yearly it will recurre on the first match of the weekdays according to the value of Recurrence.getWeekOfMonth().

Specified by:

getWeekdays in interface Recurrence

Returns:

the WeekdaySet or null.

setWeekdays

public void setWeekdays(WeekdaySet weekdays)

Parameters:

weekdays - are the weekdays to set.

getWeekOfMonth

public WeekOfMonth getWeekOfMonth()

Description copied from interface: Recurrence

This method gets the WeekOfMonth of a monthly or yearly recurrence. By default (if this method returns null and Recurrence.getWeekdays() returns WeekdaySet.ALL) such recurrence always takes place on a fixed day of the month based on the initial occurrence. However, to specify a monthly or yearly Recurrence taking place on a specific day of the week this method can return a value identifying the week within the month (e.g. "on first Friday every month", or "on last weekday every month"). This method is ignored if this is NOT a monthly or yearly Recurrence.

Specified by:

getWeekOfMonth in interface Recurrence

Returns:

the WeekOfMonth or null.

setWeekOfMonth

public void setWeekOfMonth(WeekOfMonth weekOfMonth)

Parameters:

weekOfMonth - is the weekOfMonth to set.