|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.fortuna.ical4j.model.Recur
public class Recur
Defines a recurrence.
Field Summary | |
---|---|
static java.lang.String |
DAILY
|
static java.lang.String |
HOURLY
|
static java.lang.String |
MINUTELY
|
static java.lang.String |
MONTHLY
|
static java.lang.String |
SECONDLY
|
static java.lang.String |
WEEKLY
|
static java.lang.String |
YEARLY
|
Constructor Summary | |
---|---|
Recur(java.lang.String aValue)
Constructs a new instance from the specified string value. |
|
Recur(java.lang.String frequency,
Date until)
|
|
Recur(java.lang.String frequency,
int count)
|
Method Summary | |
---|---|
int |
getCount()
|
DateList |
getDates(Date seed,
Date periodStart,
Date periodEnd,
Value value)
Returns a list of start dates in the specified period represented by this recur. |
DateList |
getDates(Date seed,
Date periodStart,
Date periodEnd,
Value value,
int maxCount)
Returns a list of start dates in the specified period represented by this recur. |
DateList |
getDates(Date periodStart,
Date periodEnd,
Value value)
Returns a list of start dates in the specified period represented by this recur. |
DateList |
getDates(Date seed,
Period period,
Value value)
Convenience method for retrieving recurrences in a specified period. |
WeekDayList |
getDayList()
|
java.util.Map |
getExperimentalValues()
|
java.lang.String |
getFrequency()
|
NumberList |
getHourList()
|
int |
getInterval()
|
NumberList |
getMinuteList()
|
NumberList |
getMonthDayList()
|
NumberList |
getMonthList()
|
NumberList |
getSecondList()
|
NumberList |
getSetPosList()
|
Date |
getUntil()
|
NumberList |
getWeekNoList()
|
java.lang.String |
getWeekStartDay()
|
NumberList |
getYearDayList()
|
void |
setCount(int count)
|
void |
setFrequency(java.lang.String frequency)
|
void |
setInterval(int interval)
|
void |
setUntil(Date until)
|
void |
setWeekStartDay(java.lang.String weekStartDay)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SECONDLY
public static final java.lang.String MINUTELY
public static final java.lang.String HOURLY
public static final java.lang.String DAILY
public static final java.lang.String WEEKLY
public static final java.lang.String MONTHLY
public static final java.lang.String YEARLY
Constructor Detail |
---|
public Recur(java.lang.String aValue) throws java.text.ParseException
aValue
- a string representation of a recurrence.
java.text.ParseException
- thrown when the specified string contains an invalid representation of an UNTIL date value
java.lang.IllegalArgumentException
- if the frequency
is null
or unrecognized.public Recur(java.lang.String frequency, Date until)
frequency
- until
-
java.lang.IllegalArgumentException
- if the frequency
is null
or unrecognized.public Recur(java.lang.String frequency, int count)
frequency
- count
-
java.lang.IllegalArgumentException
- if the frequency
is null
or unrecognized.Method Detail |
---|
public final WeekDayList getDayList()
public final NumberList getHourList()
public final NumberList getMinuteList()
public final NumberList getMonthDayList()
public final NumberList getMonthList()
public final NumberList getSecondList()
public final NumberList getSetPosList()
public final NumberList getWeekNoList()
public final NumberList getYearDayList()
public final int getCount()
public final java.util.Map getExperimentalValues()
public final java.lang.String getFrequency()
public final int getInterval()
public final Date getUntil()
public final java.lang.String getWeekStartDay()
public final void setWeekStartDay(java.lang.String weekStartDay)
weekStartDay
- The weekStartDay to set.public final java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public final DateList getDates(Date periodStart, Date periodEnd, Value value)
periodStart
- the start of the periodperiodEnd
- the end of the periodvalue
- the type of dates to generate (i.e. date/date-time)
public final DateList getDates(Date seed, Period period, Value value)
period
- the period of returned recurrence datesvalue
- type of dates to generate
public final DateList getDates(Date seed, Date periodStart, Date periodEnd, Value value)
seed
- the start date of this Recurrence's first instanceperiodStart
- the start of the periodperiodEnd
- the end of the periodvalue
- the type of dates to generate (i.e. date/date-time)
public final DateList getDates(Date seed, Date periodStart, Date periodEnd, Value value, int maxCount)
seed
- the start date of this Recurrence's first instanceperiodStart
- the start of the periodperiodEnd
- the end of the periodvalue
- the type of dates to generate (i.e. date/date-time)maxCount
- limits the number of instances returned. Up to one years
worth extra may be returned. Less than 0 means no limit
public final void setCount(int count)
count
- The count to set.public final void setFrequency(java.lang.String frequency)
frequency
- The frequency to set.
java.lang.IllegalArgumentException
- if the frequency
is null
or unrecognized.public final void setInterval(int interval)
interval
- The interval to set.public final void setUntil(Date until)
until
- The until to set.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |