A C D E G H I J L M N P R S T V

A

add(SchedulingPattern, Task) - Method in class it.sauronsoftware.cron4j.TaskTable

Adds a task and an associated scheduling pattern to the table.

addSchedulerListener(SchedulerListener) - Method in class it.sauronsoftware.cron4j.Scheduler

Adds a SchedulerListener to the scheduler.

addTaskCollector(TaskCollector) - Method in class it.sauronsoftware.cron4j.Scheduler

Adds a custom TaskCollector instance to the scheduler.

addTaskExecutorListener(TaskExecutorListener) - Method in class it.sauronsoftware.cron4j.TaskExecutor

Adds a listener to the executor.

C

canBePaused() - Method in class it.sauronsoftware.cron4j.Task

Checks whether this task supports pause requests.

canBePaused() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Checks whether this executor supports pausing.

canBeStopped() - Method in class it.sauronsoftware.cron4j.ProcessTask

Returns true.

canBeStopped() - Method in class it.sauronsoftware.cron4j.Task

Checks whether this task supports stop requests.

canBeStopped() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Checks whether this executor supports stopping.

completenessValueChanged(TaskExecutor, double) - Method in interface it.sauronsoftware.cron4j.TaskExecutorListener

Called every time the execution completeness value changes.

CronParser - Class in it.sauronsoftware.cron4j

A parser for crontab-like formatted files and streams.

D

dayOfMonthMatchers - Variable in class it.sauronsoftware.cron4j.SchedulingPattern

The ValueMatcher list for the "day of month" field.

dayOfWeekMatchers - Variable in class it.sauronsoftware.cron4j.SchedulingPattern

The ValueMatcher list for the "day of week" field.

deschedule(Object) - Method in class it.sauronsoftware.cron4j.Scheduler

Deprecated. Use Scheduler.deschedule(String).

deschedule(String) - Method in class it.sauronsoftware.cron4j.Scheduler

This methods cancels the scheduling of a task.

descheduleFile(File) - Method in class it.sauronsoftware.cron4j.Scheduler

Removes a File instance previously scheduled with the Scheduler.scheduleFile(File) method.

E

execute(TaskExecutionContext) - Method in class it.sauronsoftware.cron4j.ProcessTask

Implements Task.execute(TaskExecutionContext).

execute(TaskExecutionContext) - Method in class it.sauronsoftware.cron4j.Task

This method is called to require a task execution, and should contains the core routine of any scheduled task.

executionPausing(TaskExecutor) - Method in interface it.sauronsoftware.cron4j.TaskExecutorListener

Called when the execution has been requested to be paused.

executionResuming(TaskExecutor) - Method in interface it.sauronsoftware.cron4j.TaskExecutorListener

Called when the execution has been requested to be resumed.

executionStopping(TaskExecutor) - Method in interface it.sauronsoftware.cron4j.TaskExecutorListener

Called when the executor has been requested to be stopped.

executionTerminated(TaskExecutor, Throwable) - Method in interface it.sauronsoftware.cron4j.TaskExecutorListener

Called at execution end.

G

getCommand() - Method in class it.sauronsoftware.cron4j.ProcessTask

Returns the command executed by this task.

getCompleteness() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Returns the current completeness value, which is a value between 0 and 1.

getDirectory() - Method in class it.sauronsoftware.cron4j.ProcessTask

Resturns the working directory for the spawned process.

getEnvs() - Method in class it.sauronsoftware.cron4j.ProcessTask

Returns the environment variables, in the name=value form, used by the task to run its process.

getExecutingTasks() - Method in class it.sauronsoftware.cron4j.Scheduler

Returns an array containing any currently executing task, in the form of TaskExecutor objects.

getGuid() - Method in class it.sauronsoftware.cron4j.Scheduler

It returns the GUID for this scheduler.

getGuid() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Returns a GUID for this executor.

getScheduledFiles() - Method in class it.sauronsoftware.cron4j.Scheduler

Returns an array containing any File previously scheduled with the Scheduler.scheduleFile(File) method.

getScheduler() - Method in interface it.sauronsoftware.cron4j.TaskExecutionContext

Returns the scheduler.

getScheduler() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Returns the Scheduler instance whose this executor belongs to.

getSchedulerListeners() - Method in class it.sauronsoftware.cron4j.Scheduler

Returns an array containing any SchedulerListener previously registered with the Scheduler.addSchedulerListener(SchedulerListener) method.

getSchedulingPattern(String) - Method in class it.sauronsoftware.cron4j.Scheduler

This method retrieves a previously scheduled task scheduling pattern.

getSchedulingPattern(int) - Method in class it.sauronsoftware.cron4j.TaskTable

Returns the scheduling pattern at the specified position.

getStartTime() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Returns a time stamp reporting the start time of this executor, or a value less than 0 if this executor has not been yet started.

getStatusMessage() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Returns the current status message.

getStderrFile() - Method in class it.sauronsoftware.cron4j.ProcessTask

Returns the standard error file (optional).

getStdinFile() - Method in class it.sauronsoftware.cron4j.ProcessTask

Returns the standard input file (optional).

getStdoutFile() - Method in class it.sauronsoftware.cron4j.ProcessTask

Returns the standard output file (optional).

getTask(String) - Method in class it.sauronsoftware.cron4j.Scheduler

This method retrieves a previously scheduled task.

getTask() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Returns the representation of the executed task.

getTask(int) - Method in class it.sauronsoftware.cron4j.TaskTable

Returns the task at the specified position.

getTaskCollectors() - Method in class it.sauronsoftware.cron4j.Scheduler

Returns an array containing any custom TaskCollector instance previously registered in the scheduler with the Scheduler.addTaskCollector(TaskCollector) method.

getTaskExecutor() - Method in interface it.sauronsoftware.cron4j.TaskExecutionContext

Returns the task executor.

getTaskExecutorListeners() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Returns an array containing any TaskExecutorListener previously registered with the TaskExecutor.addTaskExecutorListener(TaskExecutorListener) method.

getTaskRunnable(Object) - Method in class it.sauronsoftware.cron4j.Scheduler

Deprecated. Use Scheduler.getTask(String).

getTasks() - Method in interface it.sauronsoftware.cron4j.TaskCollector

Once the instance has been registered on a Scheduler instance, with the Scheduler.addTaskCollector(TaskCollector) method, this method will be queried once a minute.

getTaskSchedulingPattern(Object) - Method in class it.sauronsoftware.cron4j.Scheduler

Deprecated. Use Scheduler.getSchedulingPattern(String).

getTimeZone() - Method in class it.sauronsoftware.cron4j.Scheduler

Returns the time zone applied by the scheduler.

H

hourMatchers - Variable in class it.sauronsoftware.cron4j.SchedulingPattern

The ValueMatcher list for the "hour" field.

I

InvalidPatternException - Exception in it.sauronsoftware.cron4j

This kind of exception is thrown if an invalid scheduling pattern is encountered by the scheduler.

isAlive() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Tests if this executor is alive.

isDaemon() - Method in class it.sauronsoftware.cron4j.Scheduler

Tests whether this scheduler is a daemon scheduler.

isPaused() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Tests whether this executor has been paused.

isStarted() - Method in class it.sauronsoftware.cron4j.Scheduler

Tests if this scheduler is started.

isStopped() - Method in interface it.sauronsoftware.cron4j.TaskExecutionContext

Checks whether the task execution has been demanded to be stopped.

isStopped() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Tests whether this executor has been stopped.

it.sauronsoftware.cron4j - package it.sauronsoftware.cron4j

The classes in this package implement a UNIX cron-like scheduler for the Java 2 1.2 (or later) platform.

J

join() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Waits for this executor to die.

L

launch(Task) - Method in class it.sauronsoftware.cron4j.Scheduler

Executes immediately a task, without scheduling it.

M

match(TimeZone, long) - Method in class it.sauronsoftware.cron4j.SchedulingPattern

This methods returns true if the given timestamp (expressed as a UNIX-era millis value) matches the pattern, according to the given time zone.

match(long) - Method in class it.sauronsoftware.cron4j.SchedulingPattern

This methods returns true if the given timestamp (expressed as a UNIX-era millis value) matches the pattern, according to the system default time zone.

matcherSize - Variable in class it.sauronsoftware.cron4j.SchedulingPattern

How many matcher groups in this pattern?

minuteMatchers - Variable in class it.sauronsoftware.cron4j.SchedulingPattern

The ValueMatcher list for the "minute" field.

monthMatchers - Variable in class it.sauronsoftware.cron4j.SchedulingPattern

The ValueMatcher list for the "month" field.

N

nextMatchingDate() - Method in class it.sauronsoftware.cron4j.Predictor

It returns the next matching moment as a Date object.

nextMatchingTime() - Method in class it.sauronsoftware.cron4j.Predictor

It returns the next matching moment as a millis value.

P

parse(File) - Static method in class it.sauronsoftware.cron4j.CronParser

Builds a task list reading it from a file.

parse(URL) - Static method in class it.sauronsoftware.cron4j.CronParser

Builds a task list reading it from an URL.

parse(InputStream) - Static method in class it.sauronsoftware.cron4j.CronParser

Builds a task list reading it from an input stream.

parse(Reader) - Static method in class it.sauronsoftware.cron4j.CronParser

Builds a task list reading it from a reader.

parseLine(TaskTable, String) - Static method in class it.sauronsoftware.cron4j.CronParser

Parses a crontab-like line.

pause() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Pauses the ongoing execution.

pauseIfRequested() - Method in interface it.sauronsoftware.cron4j.TaskExecutionContext

If the task execution has been paused, stops until the operation is resumed.

Predictor - Class in it.sauronsoftware.cron4j

A predictor is able to predict when a scheduling pattern will be matched.

Predictor(String, long) - Constructor for class it.sauronsoftware.cron4j.Predictor

It builds a predictor with the given scheduling pattern and start time.

Predictor(String, Date) - Constructor for class it.sauronsoftware.cron4j.Predictor

It builds a predictor with the given scheduling pattern and start time.

Predictor(String) - Constructor for class it.sauronsoftware.cron4j.Predictor

It builds a predictor with the given scheduling pattern and the current system time as the prediction start time.

Predictor(SchedulingPattern, long) - Constructor for class it.sauronsoftware.cron4j.Predictor

It builds a predictor with the given scheduling pattern and start time.

Predictor(SchedulingPattern, Date) - Constructor for class it.sauronsoftware.cron4j.Predictor

It builds a predictor with the given scheduling pattern and start time.

Predictor(SchedulingPattern) - Constructor for class it.sauronsoftware.cron4j.Predictor

It builds a predictor with the given scheduling pattern and the current system time as the prediction start time.

ProcessTask - Class in it.sauronsoftware.cron4j

A built-in Task implementation which can be used to run an external process.

ProcessTask(String[], String[], File) - Constructor for class it.sauronsoftware.cron4j.ProcessTask

Creates the task.

ProcessTask(String[], String[]) - Constructor for class it.sauronsoftware.cron4j.ProcessTask

Creates the task.

ProcessTask(String[]) - Constructor for class it.sauronsoftware.cron4j.ProcessTask

Creates the task.

ProcessTask(String) - Constructor for class it.sauronsoftware.cron4j.ProcessTask

Creates the task.

R

remove(int) - Method in class it.sauronsoftware.cron4j.TaskTable

Remove a task from the table.

removeSchedulerListener(SchedulerListener) - Method in class it.sauronsoftware.cron4j.Scheduler

Removes a SchedulerListener previously registered with the Scheduler.addSchedulerListener(SchedulerListener) method.

removeTaskCollector(TaskCollector) - Method in class it.sauronsoftware.cron4j.Scheduler

Removes a previously registered custom TaskCollector instance.

removeTaskExecutorListener(TaskExecutorListener) - Method in class it.sauronsoftware.cron4j.TaskExecutor

Removes a listener from the executor.

reschedule(Object, String) - Method in class it.sauronsoftware.cron4j.Scheduler

Deprecated. Use Scheduler.reschedule(String, String).

reschedule(String, String) - Method in class it.sauronsoftware.cron4j.Scheduler

This method changes the scheduling pattern of a task.

reschedule(String, SchedulingPattern) - Method in class it.sauronsoftware.cron4j.Scheduler

This method changes the scheduling pattern of a task.

resume() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Resumes the execution after it has been paused.

S

schedule(String, Runnable) - Method in class it.sauronsoftware.cron4j.Scheduler

This method schedules a task execution.

schedule(String, Task) - Method in class it.sauronsoftware.cron4j.Scheduler

This method schedules a task execution.

schedule(SchedulingPattern, Task) - Method in class it.sauronsoftware.cron4j.Scheduler

This method schedules a task execution.

scheduleFile(File) - Method in class it.sauronsoftware.cron4j.Scheduler

Adds a File instance to the scheduler.

Scheduler - Class in it.sauronsoftware.cron4j

The cron4j scheduler.

Scheduler() - Constructor for class it.sauronsoftware.cron4j.Scheduler

It builds and prepares a brand new Scheduler instance.

SchedulerListener - Interface in it.sauronsoftware.cron4j

Implement this interface and register your instance with the Scheduler.addSchedulerListener(SchedulerListener) method to receive notifications about scheduled task executions.

SchedulingPattern - Class in it.sauronsoftware.cron4j

A UNIX crontab-like pattern is a string split in five space separated parts.

SchedulingPattern(String) - Constructor for class it.sauronsoftware.cron4j.SchedulingPattern

Builds a SchedulingPattern parsing it from a string.

SchedulingPatternValidator - Class in it.sauronsoftware.cron4j

Deprecated. Use SchedulingPattern.validate(String).

SchedulingPatternValidator() - Constructor for class it.sauronsoftware.cron4j.SchedulingPatternValidator

Deprecated.

setCommand(String[]) - Method in class it.sauronsoftware.cron4j.ProcessTask

Sets the command executed by this task.

setCompleteness(double) - Method in interface it.sauronsoftware.cron4j.TaskExecutionContext

Sets the completeness tracking value, that has to be between 0 and 1.

setDaemon(boolean) - Method in class it.sauronsoftware.cron4j.Scheduler

Marks this scheduler daemon flag.

setDirectory(File) - Method in class it.sauronsoftware.cron4j.ProcessTask

Sets the working directory for the spawned process.

setEnvs(String[]) - Method in class it.sauronsoftware.cron4j.ProcessTask

Sets the environment variables, in the name=value form, used by the task to run its process.

setStatusMessage(String) - Method in interface it.sauronsoftware.cron4j.TaskExecutionContext

Sets the current status tracking message, that has to be something about what the task is doing at the moment.

setStderrFile(File) - Method in class it.sauronsoftware.cron4j.ProcessTask

Sets the standard error file (optional).

setStdinFile(File) - Method in class it.sauronsoftware.cron4j.ProcessTask

Sets the standard input file (optional).

setStdoutFile(File) - Method in class it.sauronsoftware.cron4j.ProcessTask

Sets the standard output file (optional).

setTimeZone(TimeZone) - Method in class it.sauronsoftware.cron4j.Scheduler

Sets the time zone applied by the scheduler.

size() - Method in class it.sauronsoftware.cron4j.TaskTable

Returns the size of the table, representing the number of the elements stored in it.

start() - Method in class it.sauronsoftware.cron4j.Scheduler

This method starts the scheduler.

statusMessageChanged(TaskExecutor, String) - Method in interface it.sauronsoftware.cron4j.TaskExecutorListener

Called every time the execution status message changes.

stop() - Method in class it.sauronsoftware.cron4j.Scheduler

This method stops the scheduler execution.

stop() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Stops the ongoing execution.

supportsCompletenessTracking() - Method in class it.sauronsoftware.cron4j.Task

Tests whether this task supports completeness tracking.

supportsCompletenessTracking() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Checks whether this executor provides completeness tracking informations.

supportsStatusTracking() - Method in class it.sauronsoftware.cron4j.Task

Tests whether this task supports status tracking.

supportsStatusTracking() - Method in class it.sauronsoftware.cron4j.TaskExecutor

Checks whether this executor provides status tracking messages.

T

Task - Class in it.sauronsoftware.cron4j

Abstract base representation of a cron4j task.

Task() - Constructor for class it.sauronsoftware.cron4j.Task

Empty constructor, does nothing.

TaskCollector - Interface in it.sauronsoftware.cron4j

This interface describes a task collector.

TaskExecutionContext - Interface in it.sauronsoftware.cron4j

A TaskExecutionContext object provides support methods for the execution of a task.

TaskExecutor - Class in it.sauronsoftware.cron4j

Represents a task executor, which is something similar to threads.

TaskExecutorListener - Interface in it.sauronsoftware.cron4j

A TaskExecutorListener is notified with events from a TaskExecutor.

taskFailed(TaskExecutor, Throwable) - Method in interface it.sauronsoftware.cron4j.SchedulerListener

This one is called by the scheduler to notify that a task execution has failed.

taskLaunching(TaskExecutor) - Method in interface it.sauronsoftware.cron4j.SchedulerListener

This one is called by the scheduler when a task execution is starting.

taskSucceeded(TaskExecutor) - Method in interface it.sauronsoftware.cron4j.SchedulerListener

This one is called by the scheduler to notify that a task execution has been successfully completed.

TaskTable - Class in it.sauronsoftware.cron4j

A table coupling tasks with scheduling patterns.

TaskTable() - Constructor for class it.sauronsoftware.cron4j.TaskTable

toString() - Method in class it.sauronsoftware.cron4j.ProcessTask

Overrides Object.toString().

toString() - Method in class it.sauronsoftware.cron4j.SchedulingPattern

Returns the pattern as a string.

V

validate(String) - Static method in class it.sauronsoftware.cron4j.SchedulingPattern

Validates a string as a scheduling pattern.

validate(String) - Static method in class it.sauronsoftware.cron4j.SchedulingPatternValidator

Deprecated. Use SchedulingPattern.validate(String).

A C D E G H I J L M N P R S T V