rs.baselib.util

Class CronSchedule

java.lang.Object

rs.baselib.util.CronSchedule

public class CronSchedule
extends Object

Provides cron-like scheduling information. This class implements cron-like definition of scheduling information. Various methods can be used to check whether a timestamp matches the schedule or not. However, there is a slight difference between cron and this class. Cron describes a match when either the day of month and month or the day of week are met. This class requires both to be met for a match. Also note that Calendar defines Sunday through Saturday with 1 through 7 respectively

Author:

RalphSchuster

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CronSchedule.AbstractTimeValue Base class for timing values.
static class	CronSchedule.SingleTimeValue Represents a single time value, e.g. 9
static class	CronSchedule.TimeAll Represents the ALL time, *.
static class	CronSchedule.TimeRange Represents a time range, e.g. 5-9
static class	CronSchedule.TimeSteps Represents a time interval, e.g. 0-4/10

Field Summary

Fields

Modifier and Type	Field and Description
protected static int[]	TYPES Types being used.

Constructor Summary

Constructors

Constructor and Description
CronSchedule() Default constructor Constructor with all terms set to "*".
CronSchedule(String schedule) Constructor with cron-style string initialization.
CronSchedule(String min, String hour, String dom, String mon, String dow) Constructor with separate initialization values.

Method Summary

Methods

Modifier and Type	Method and Description
String	get(int type) Returns the cron-like definition string for the given time value
protected Calendar	getCalendar(long timeStamp) Creates the calendar for a timestamp.
protected static int	getIndex(int type) Returns the index for the specified Calendar type.
protected static int	getType(int index) Returns the type at the specified index
protected CronSchedule.AbstractTimeValue[]	getValues(int type) Returns the values for a specific time type
boolean	isDay(Calendar cal) Checks whether given calendar date matches with defined day schedule.
boolean	isDay(long timestamp) Checks whether given timestamp matches with defined day schedule.
boolean	isHour(Calendar cal) Checks whether given calendar date matches with defined hour schedule.
boolean	isHour(long timestamp) Checks whether given timestamp matches with defined hour schedule.
boolean	isMinute(Calendar cal) Checks whether given calendar date matches with defined schedule.
boolean	isMinute(long timeStamp) Checks whether given timestamp matches with defined schedule.
boolean	matches(Calendar cal) Checks whether given timestamp matches with defined schedule.
protected boolean	matches(int type, Calendar calendar) Checks whether specific schedule definition matches against the given calendar date.
boolean	matches(long timeStamp) Checks whether given timestamp matches with defined schedule.
protected void	set(int type, CronSchedule.AbstractTimeValue[] values) Sets the values for a specific type
void	set(int type, String values) Sets the time values accordingly
String	set(String schedule) Sets the cron schedule.
String	toString() Returns the cron-like definition of the schedule.

Methods inherited from class java.lang.Object

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

Field Detail

TYPES

protected static int[] TYPES

Types being used. This array defines the types and their indices.

Constructor Detail

CronSchedule

public CronSchedule()

Default constructor Constructor with all terms set to "*".

CronSchedule

public CronSchedule(String schedule)

Constructor with cron-style string initialization. The cron style is: $minute $hour $dayOfMonth $month $dayOfWeek

Parameters:

schedule -

CronSchedule

public CronSchedule(String min,
            String hour,
            String dom,
            String mon,
            String dow)

Constructor with separate initialization values.

Parameters:

min - - minute definition

hour - - hour definition

dom - - day of month definition

mon - - month definition

dow - - day of week definition

Method Detail

set

public String set(String schedule)

Sets the cron schedule. The cron style is: $minute $hour $dayOfMonth $month $dayOfWeek The function will return any characters that follow the cron definition

Parameters:

schedule - - cron-like schedule definition

Returns:

characters following the cron definition.

set

public void set(int type,
       String values)

Sets the time values accordingly

Parameters:

type - - Calendar constant to define what values will be set

values - - comma-separated list of definitions for that type

set

protected void set(int type,
       CronSchedule.AbstractTimeValue[] values)

Sets the values for a specific type

Parameters:

type - - Calendar constant defining the time type

values - - values to be set

getValues

protected CronSchedule.AbstractTimeValue[] getValues(int type)

Returns the values for a specific time type

Parameters:

type - - Calendar constant defining the type

Returns:

time value definitions

get

public String get(int type)

Returns the cron-like definition string for the given time value

Parameters:

type - - Calendar constant defining time type

Returns:

cron-like definition

toString

public String toString()

Returns the cron-like definition of the schedule.

Overrides:

toString in class Object

matches

public boolean matches(long timeStamp)

Checks whether given timestamp matches with defined schedule. This is default check method. All criteria must be met including seconds to be 0.

Parameters:

timeStamp - - time in ms since Epoch time

Returns:

true when schedule matches

matches

public boolean matches(Calendar cal)

Checks whether given timestamp matches with defined schedule. This is default check method. All criteria must be met including seconds to be 0.

Parameters:

cal - - calendar date

Returns:

true when schedule matches

isMinute

public boolean isMinute(long timeStamp)

Checks whether given timestamp matches with defined schedule. This method can be used when seconds are not relevant for matching. This is default check method.

Parameters:

timeStamp - - time in ms since Epoch time

Returns:

true when schedule matches

isMinute

public boolean isMinute(Calendar cal)

Checks whether given calendar date matches with defined schedule. This method can be used when seconds are not relevant for matching.

Parameters:

cal - - calendar date

Returns:

true when schedule matches

isHour

public boolean isHour(long timestamp)

Checks whether given timestamp matches with defined hour schedule. This method can be used when minute definition is not relevant for matching.

Parameters:

timestamp - - time in ms since Epoch time

Returns:

true when schedule matches

isHour

public boolean isHour(Calendar cal)

Checks whether given calendar date matches with defined hour schedule. This method can be used when minute definition is not relevant for matching.

Parameters:

cal - - calendar date

Returns:

true when schedule matches

isDay

public boolean isDay(long timestamp)

Checks whether given timestamp matches with defined day schedule. This method can be used when minute and hour definitions are not relevant for matching.

Parameters:

timestamp - - time in ms since Epoch time

Returns:

true when schedule matches

isDay

public boolean isDay(Calendar cal)

Checks whether given calendar date matches with defined day schedule. This method can be used when minute and hour definitions are not relevant for matching.

Parameters:

cal - - calendar date

Returns:

true when schedule matches

matches

protected boolean matches(int type,
              Calendar calendar)

Checks whether specific schedule definition matches against the given calendar date.

Parameters:

type - - Calendar constant defining time type to check for

calendar - - calendar representing the date to check

Returns:

true when definition matches

getCalendar

protected Calendar getCalendar(long timeStamp)

Creates the calendar for a timestamp.

Parameters:

timeStamp - - timestamp

Returns:

calendar

getType

protected static int getType(int index)

Returns the type at the specified index

Parameters:

index - - index

Returns:

Calendar constant of type

getIndex

protected static int getIndex(int type)

Returns the index for the specified Calendar type.

Parameters:

type - - Calendar constant for type

Returns:

internal index