biweekly.util

Class Recurrence.Builder

java.lang.Object

biweekly.util.Recurrence.Builder

Enclosing class:

Recurrence

public static class Recurrence.Builder
extends Object

Constructs Recurrence objects.

Author:

Michael Angstadt

Constructor Summary

Constructors

Constructor and Description
Recurrence.Builder(Recurrence.Frequency frequency) Constructs a new builder.
Recurrence.Builder(Recurrence recur) Constructs a new builder

Method Summary

Methods

Modifier and Type	Method and Description
Recurrence	build() Builds the final Recurrence object.
Recurrence.Builder	byDay(Collection<Recurrence.DayOfWeek> days) Adds one or more BYDAY rule parts.
Recurrence.Builder	byDay(Integer num, Recurrence.DayOfWeek day) Adds a BYDAY rule part.
Recurrence.Builder	byDay(Recurrence.DayOfWeek... days) Adds one or more BYDAY rule parts.
Recurrence.Builder	byHour(Collection<Integer> hours) Adds one or more BYHOUR rule parts.
Recurrence.Builder	byHour(Integer... hours) Adds one or more BYHOUR rule parts.
Recurrence.Builder	byMinute(Collection<Integer> minutes) Adds one or more BYMINUTE rule parts.
Recurrence.Builder	byMinute(Integer... minutes) Adds one or more BYMINUTE rule parts.
Recurrence.Builder	byMonth(Collection<Integer> months) Adds one or more BYMONTH rule parts.
Recurrence.Builder	byMonth(Integer... months) Adds one or more BYMONTH rule parts.
Recurrence.Builder	byMonthDay(Collection<Integer> monthDays) Adds one or more BYMONTHDAY rule parts.
Recurrence.Builder	byMonthDay(Integer... monthDays) Adds one or more BYMONTHDAY rule parts.
Recurrence.Builder	bySecond(Collection<Integer> seconds) Adds one or more BYSECOND rule parts.
Recurrence.Builder	bySecond(Integer... seconds) Adds one or more BYSECOND rule parts.
Recurrence.Builder	bySetPos(Collection<Integer> positions) Adds one or more BYSETPOS rule parts.
Recurrence.Builder	bySetPos(Integer... positions) Adds one or more BYSETPOS rule parts.
Recurrence.Builder	byWeekNo(Collection<Integer> weekNumbers) Adds one or more BYWEEKNO rule parts.
Recurrence.Builder	byWeekNo(Integer... weekNumbers) Adds one or more BYWEEKNO rule parts.
Recurrence.Builder	byYearDay(Collection<Integer> yearDays) Adds one or more BYYEARDAY rule parts.
Recurrence.Builder	byYearDay(Integer... yearDays) Adds one or more BYYEARDAY rule parts.
Recurrence.Builder	count(Integer count) Gets the number of times the rule will be repeated.
Recurrence.Builder	frequency(Recurrence.Frequency frequency) Sets the frequency
Recurrence.Builder	interval(Integer interval) Gets how often the rule repeats, in relation to the frequency.
Recurrence.Builder	until(Date until) Sets the date that the recurrence stops.
Recurrence.Builder	until(Date until, boolean hasTime) Sets the date that the recurrence stops.
Recurrence.Builder	until(ICalDate until) Sets the date that the recurrence stops.
Recurrence.Builder	workweekStarts(Recurrence.DayOfWeek day) Sets the day that the work week starts.
Recurrence.Builder	xrule(String name, String value) Adds a non-standard rule part.

Methods inherited from class java.lang.Object

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

Constructor Detail

Recurrence.Builder

public Recurrence.Builder(Recurrence.Frequency frequency)

Constructs a new builder.

Parameters:

frequency - the recurrence frequency

Recurrence.Builder

public Recurrence.Builder(Recurrence recur)

Constructs a new builder

Parameters:

recur - the recurrence object to copy from

Method Detail

frequency

public Recurrence.Builder frequency(Recurrence.Frequency frequency)

Sets the frequency

Parameters:

frequency - the frequency

Returns:

this

until

public Recurrence.Builder until(ICalDate until)

Sets the date that the recurrence stops. Note that the UNTIL and COUNT fields cannot both be defined within the same rule.

Parameters:

until - the date

Returns:

this

until

public Recurrence.Builder until(Date until)

Sets the date that the recurrence stops. Note that the UNTIL and COUNT fields cannot both be defined within the same rule.

Parameters:

until - the date (time component will be included)

Returns:

this

until

public Recurrence.Builder until(Date until,
                       boolean hasTime)

Sets the date that the recurrence stops. Note that the UNTIL and COUNT fields cannot both be defined within the same rule.

Parameters:

until - the date

hasTime - true to include the time component, false if it's strictly a date

Returns:

this

count

public Recurrence.Builder count(Integer count)

Gets the number of times the rule will be repeated. Note that the UNTIL and COUNT fields cannot both be defined within the same rule.

Parameters:

count - the number of times to repeat the rule

Returns:

this

interval

public Recurrence.Builder interval(Integer interval)

Gets how often the rule repeats, in relation to the frequency.

Parameters:

interval - the repetition interval

Returns:

this

bySecond

public Recurrence.Builder bySecond(Integer... seconds)

Adds one or more BYSECOND rule parts.

Parameters:

seconds - the seconds to add

Returns:

this

bySecond

public Recurrence.Builder bySecond(Collection<Integer> seconds)

Adds one or more BYSECOND rule parts.

Parameters:

seconds - the seconds to add

Returns:

this

byMinute

public Recurrence.Builder byMinute(Integer... minutes)

Adds one or more BYMINUTE rule parts.

Parameters:

minutes - the minutes to add

Returns:

this

byMinute

public Recurrence.Builder byMinute(Collection<Integer> minutes)

Adds one or more BYMINUTE rule parts.

Parameters:

minutes - the minutes to add

Returns:

this

byHour

public Recurrence.Builder byHour(Integer... hours)

Adds one or more BYHOUR rule parts.

Parameters:

hours - the hours to add

Returns:

this

byHour

public Recurrence.Builder byHour(Collection<Integer> hours)

Adds one or more BYHOUR rule parts.

Parameters:

hours - the hours to add

Returns:

this

byMonthDay

public Recurrence.Builder byMonthDay(Integer... monthDays)

Adds one or more BYMONTHDAY rule parts.

Parameters:

monthDays - the month days to add

Returns:

this

byMonthDay

public Recurrence.Builder byMonthDay(Collection<Integer> monthDays)

Adds one or more BYMONTHDAY rule parts.

Parameters:

monthDays - the month days to add

Returns:

this

byYearDay

public Recurrence.Builder byYearDay(Integer... yearDays)

Adds one or more BYYEARDAY rule parts.

Parameters:

yearDays - the year days to add

Returns:

this

byYearDay

public Recurrence.Builder byYearDay(Collection<Integer> yearDays)

Adds one or more BYYEARDAY rule parts.

Parameters:

yearDays - the year days to add

Returns:

this

byWeekNo

public Recurrence.Builder byWeekNo(Integer... weekNumbers)

Adds one or more BYWEEKNO rule parts.

Parameters:

weekNumbers - the week numbers to add

Returns:

this

byWeekNo

public Recurrence.Builder byWeekNo(Collection<Integer> weekNumbers)

Adds one or more BYWEEKNO rule parts.

Parameters:

weekNumbers - the week numbers to add

Returns:

this

byMonth

public Recurrence.Builder byMonth(Integer... months)

Adds one or more BYMONTH rule parts.

Parameters:

months - the months to add

Returns:

this

byMonth

public Recurrence.Builder byMonth(Collection<Integer> months)

Adds one or more BYMONTH rule parts.

Parameters:

months - the months to add

Returns:

this

bySetPos

public Recurrence.Builder bySetPos(Integer... positions)

Adds one or more BYSETPOS rule parts.

Parameters:

positions - the values to add

Returns:

this

bySetPos

public Recurrence.Builder bySetPos(Collection<Integer> positions)

Adds one or more BYSETPOS rule parts.

Parameters:

positions - the values to add

Returns:

this

byDay

public Recurrence.Builder byDay(Recurrence.DayOfWeek... days)

Adds one or more BYDAY rule parts.

Parameters:

days - the days to add

Returns:

this

byDay

public Recurrence.Builder byDay(Collection<Recurrence.DayOfWeek> days)

Adds one or more BYDAY rule parts.

Parameters:

days - the days to add

Returns:

this

byDay

public Recurrence.Builder byDay(Integer num,
                       Recurrence.DayOfWeek day)

Adds a BYDAY rule part.

Parameters:

num - the numeric component

day - the day to add

Returns:

this

workweekStarts

public Recurrence.Builder workweekStarts(Recurrence.DayOfWeek day)

Sets the day that the work week starts.

Parameters:

day - the day

Returns:

this

xrule

public Recurrence.Builder xrule(String name,
                       String value)

Adds a non-standard rule part.

Parameters:

name - the name

value - the value or null to remove the rule part

Returns:

this

build

public Recurrence build()

Builds the final Recurrence object.

Returns:

the object