Package org.pentaho.platform.scheduler2.recur

Class IncrementalRecurrence

java.lang.Object

org.pentaho.platform.scheduler2.recur.IncrementalRecurrence

All Implemented Interfaces:

ITimeRecurrence

public class IncrementalRecurrence
extends Object
implements ITimeRecurrence

Used to specify incremental dates or times. For example an incremental recurrence with 1 as a starting value and 3 as an increment translates to 1, 4, 7, etc. The time units may represent years, or days of month or hours, etc. The method to which this class is passed will determine the meaning of the integers within the list.

Author:

arodriguez

Constructor Summary

Constructors

Constructor	Description
IncrementalRecurrence()	Creates a new incremental recurrence with a null starting value and increment
IncrementalRecurrence(Integer startingValue, Integer increment)	Creates a new incremental recurrence.
IncrementalRecurrence(String startingValue, Integer increment)	Creates a new incremental recurrence.

Method Summary

Modifier and Type	Method	Description
Integer	getIncrement()	Returns the increment
String	getStartingValue()	Returns the starting value
void	setIncrement(Integer increment)	Sets the increment
void	setStartingValue(String startingValue)	Sets the starting value

Methods inherited from class java.lang.Object

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

Constructor Details

IncrementalRecurrence

public IncrementalRecurrence()

Creates a new incremental recurrence with a null starting value and increment

IncrementalRecurrence

public IncrementalRecurrence(Integer startingValue,
 Integer increment)

Creates a new incremental recurrence.

Parameters:

startingValue - the starting value

increment - the increment

IncrementalRecurrence

public IncrementalRecurrence(String startingValue,
 Integer increment)

Creates a new incremental recurrence.

Parameters:

startingValue - the starting value

increment - the increment

Method Details

getStartingValue

public String getStartingValue()

Returns the starting value

Returns:

the starting value

setStartingValue

public void setStartingValue(String startingValue)

Sets the starting value

Parameters:

startingValue - the starting value

getIncrement

public Integer getIncrement()

Returns the increment

Returns:

the increment

setIncrement

public void setIncrement(Integer increment)

Sets the increment

Parameters:

increment - the increment