org.oddjob.schedules.schedules

Class OccurrenceSchedule

java.lang.Object

org.oddjob.schedules.AbstractSchedule

org.oddjob.schedules.schedules.OccurrenceSchedule

All Implemented Interfaces:

java.io.Serializable, RefineableSchedule, Schedule

public final class OccurrenceSchedule
extends AbstractSchedule
implements java.io.Serializable

Description

This schedule counts the occurence's of it's nested schedule and returns the required occurrence.

Example

Second Tuesday of the month.

<schedules:monthly xmlns:schedules="http://rgordon.co.uk/oddjob/schedules">
    <refinement>
        <bean class="org.oddjob.schedules.schedules.OccurrenceSchedule" occurrence="2">
            <refinement>
                <schedules:weekly on="2"/>
            </refinement>
        </bean>
    </refinement>
</schedules:monthly>

See Also:

Serialized Form

Author:

Rob Gordon

Constructor Summary

Constructors

Constructor and Description
OccurrenceSchedule()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOccurrence() Return the number of the occurrence for this schedule.
ScheduleResult	nextDue(ScheduleContext context) Return the next due interval which is the given occurrence of it's child schedules.
void	setOccurrence(java.lang.String occurrence) Set the number of the occurrence for this schedule.
java.lang.String	toString() Override toString.

Methods inherited from class org.oddjob.schedules.AbstractSchedule

getRefinement, setRefinement

Methods inherited from class java.lang.Object

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

Constructor Detail

OccurrenceSchedule

public OccurrenceSchedule()

Method Detail

setOccurrence

public void setOccurrence(java.lang.String occurrence)

Set the number of the occurrence for this schedule.

Parameters:

occurrence - The occurence.

getOccurrence

public java.lang.String getOccurrence()

Return the number of the occurrence for this schedule.

Returns:

The occurrence.

nextDue

public ScheduleResult nextDue(ScheduleContext context)

Return the next due interval which is the given occurrence of it's child schedules.

Specified by:

nextDue in interface Schedule

Returns:

The next due interval for the schedule.

toString

public java.lang.String toString()

Override toString.

Overrides:

toString in class java.lang.Object