com.google.gerrit.server.config

Class ScheduleConfig.Schedule

java.lang.Object

com.google.gerrit.server.config.ScheduleConfig.Schedule

Enclosing class:

ScheduleConfig

public abstract static class ScheduleConfig.Schedule
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Schedule()

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<ScheduleConfig.Schedule>	create(long interval, java.lang.String startTime) Creates a schedule.
static ScheduleConfig.Schedule	createOrFail(long interval, java.lang.String startTime) Creates a schedule.
abstract long	initialDelay() Milliseconds between constructor invocation and first event time.
abstract long	interval() Number of milliseconds between events.

Methods inherited from class java.lang.Object

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

Constructor Detail

Schedule

public Schedule()

Method Detail

interval

public abstract long interval()

Number of milliseconds between events.

initialDelay

public abstract long initialDelay()

Milliseconds between constructor invocation and first event time.

If there is any lag between the constructor invocation and queuing the object into an executor the event will run later, as there is no method to adjust for the scheduling delay.

createOrFail

public static ScheduleConfig.Schedule createOrFail(long interval,
                                                   java.lang.String startTime)

Creates a schedule.

ScheduleConfig defines details about which values are valid for the interval and startTime parameters.

Parameters:

interval - the interval in milliseconds

startTime - the start time as "<day of week> <hours>:<minutes>" or "<hours>:<minutes>"

Returns:

the schedule

Throws:

java.lang.IllegalArgumentException - if any of the parameters is invalid

create

public static java.util.Optional<ScheduleConfig.Schedule> create(long interval,
                                                                 java.lang.String startTime)

Creates a schedule.

ScheduleConfig defines details about which values are valid for the interval and startTime parameters.

Parameters:

interval - the interval in milliseconds

startTime - the start time as "<day of week> <hours>:<minutes>" or "<hours>:<minutes>"

Returns:

the schedule or Optional.empty() if any of the parameters is invalid