com.silverpeas.calendar
Class RecurrencePeriod

java.lang.Object
  com.silverpeas.calendar.RecurrencePeriod

public class RecurrencePeriod
extends Object

A period of a recurrence. It defines the unit of time the recurrence is scheduled and the interval in this unit of time.

Method Summary

static RecurrencePeriod	every(int interval, TimeUnit unit)
int	getInterval() Gets the interval of this period.
TimeUnit	getUnit() Gets the unit of time of the interval.

Methods inherited from class java.lang.Object

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

Method Detail

every

public static RecurrencePeriod every(int interval,
                                     TimeUnit unit)

getInterval

public int getInterval()

Gets the interval of this period.

Returns:

the period interval.

getUnit

public TimeUnit getUnit()

Gets the unit of time of the interval.

Returns:

the unit of time on which the period is defined.