com.firebase.jobdispatcher

Class Trigger

java.lang.Object

com.firebase.jobdispatcher.Trigger

public final class Trigger
extends java.lang.Object

Generally, a Trigger is an object that can answer the question, "is this job ready to run?"

More specifically, a Trigger is an opaque, abstract class used to root the type hierarchy.

Field Summary

Fields

Modifier and Type	Field and Description
static JobTrigger.ImmediateTrigger	NOW Immediate is a Trigger that's immediately available.

Constructor Summary

Constructors

Constructor and Description
Trigger()

Method Summary

Modifier and Type	Method and Description
static JobTrigger.ContentUriTrigger	contentUriTrigger(java.util.List<ObservedUri> uris) Creates a new ContentUriTrigger based on the provided list of ObservedUri.
static JobTrigger.ExecutionWindowTrigger	executionWindow(int windowStart, int windowEnd) Creates a new ExecutionWindow based on the provided time interval.

Methods inherited from class java.lang.Object

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

Field Detail

NOW

public static final JobTrigger.ImmediateTrigger NOW

Immediate is a Trigger that's immediately available. The Job will be run as soon as the runtime constraints are satisfied.

It is invalid to schedule an Immediate with a recurring Job.

Constructor Detail

Trigger

public Trigger()

Method Detail

executionWindow

public static JobTrigger.ExecutionWindowTrigger executionWindow(int windowStart,
                                                                int windowEnd)

Creates a new ExecutionWindow based on the provided time interval.

Parameters:

windowStart - The earliest time (in seconds) the job should be considered eligible to run. Calculated from when the job was scheduled (for new jobs) or last run (for recurring jobs).

windowEnd - The latest time (in seconds) the job should be run in an ideal world. Calculated in the same way as windowStart.

Throws:

java.lang.IllegalArgumentException - if the provided parameters are too restrictive.

contentUriTrigger

public static JobTrigger.ContentUriTrigger contentUriTrigger(java.util.List<ObservedUri> uris)

Creates a new ContentUriTrigger based on the provided list of ObservedUri.

Parameters:

uris - The list of URIs to observe. The trigger will be available if a piece of content, corresponding to any of provided URIs, is updated.

Throws:

java.lang.IllegalArgumentException - if provided list of URIs is null or empty.