Package org.openhab.core.scheduler

Class CronAdjuster

java.lang.Object

org.openhab.core.scheduler.CronAdjuster

All Implemented Interfaces:

TemporalAdjuster, SchedulerTemporalAdjuster

@NonNullByDefault
public class CronAdjuster
extends Object
implements SchedulerTemporalAdjuster

This class creates a TemporalAdjuster that takes a temporal and adjust it to the next deadline based on a cron specification.

Author:

Peter Kriens - Initial contribution, Hilbrand Bouwkamp - code cleanup

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANNUALLY
static final String	DAILY
static final String	HOURLY
static final String	MONTHLY
static final String	REBOOT
static final String	WEEKLY
static final String	YEARLY

Constructor Summary

Constructors

Constructor	Description
CronAdjuster(String specification)	Constructs the class with a cron specification.

Method Summary

Modifier and Type	Method	Description
Temporal	adjustInto(@Nullable Temporal temporal)
Map<String,String>	getEnv()
boolean	isDone(Temporal temporal)	Used by the scheduler to determine if it should continue scheduling jobs.
boolean	isReboot()

Methods inherited from class java.lang.Object

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

Field Details

ANNUALLY

public static final String ANNUALLY

See Also:

• Constant Field Values

YEARLY

public static final String YEARLY

See Also:

• Constant Field Values

MONTHLY

public static final String MONTHLY

See Also:

• Constant Field Values

WEEKLY

public static final String WEEKLY

See Also:

• Constant Field Values

DAILY

public static final String DAILY

See Also:

• Constant Field Values

HOURLY

public static final String HOURLY

See Also:

• Constant Field Values

REBOOT

public static final String REBOOT

See Also:

• Constant Field Values

Constructor Details

CronAdjuster

public CronAdjuster(String specification)

Constructs the class with a cron specification. containing variables and a cron expression at the last line.

Method Details

getEnv

public Map<String,String> getEnv()

Returns:

Returns a map with variables passed in the specification.

isReboot

public boolean isReboot()

Returns:

Returns true if this cron has been initialized with @reboot.

isDone

public boolean isDone(Temporal temporal)

Description copied from interface: SchedulerTemporalAdjuster

Used by the scheduler to determine if it should continue scheduling jobs. If returns true the implementation of this interface determines the job should not run again given. No new job will be scheduled.

Specified by:

isDone in interface SchedulerTemporalAdjuster

Parameters:

temporal - The temporal to determine if the next run should be scheduled

Returns:

true if running is done and the job should not run anymore.

adjustInto

public Temporal adjustInto(@Nullable Temporal temporal)

Specified by:

adjustInto in interface TemporalAdjuster