javatools.cron
Class Crontab

java.lang.Object
  |
  +--javatools.cron.Crontab

public class Crontab

extends java.lang.Object

A list of Unix style crontab entries. Capable of slurping and parsing an entire Unix style cron file.

Field Summary

(package private) java.lang.ThreadGroup

threadGroup Event threads will be executed in this thread group.

Constructor Summary

Crontab()

Crontab(java.io.BufferedReader reader, CrontabEntry.ParseSpec[] style)

Crontab(java.lang.String fileName, CrontabEntry.ParseSpec[] style)

Method Summary

java.util.Collection	getSchedule()
protected CrontabEntry	newCrontabEntry(java.lang.String str, CrontabEntry.ParseSpec[] style) We make this a separate method in case someone wants to inherit and redefine it to return something that inherits from CrontabEntry.
void	parse(java.io.BufferedReader reader, CrontabEntry.ParseSpec[] style) Reads the crontab and converts it to the internal representation The reader can come from any source.
void	parseFromFile(java.lang.String fileName, CrontabEntry.ParseSpec[] style) Reads the crontab from a file and converts it to the internal representation
void	parseLine(java.lang.String line, CrontabEntry.ParseSpec[] style)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

threadGroup

java.lang.ThreadGroup threadGroup

Event threads will be executed in this thread group.

Constructor Detail

Crontab

public Crontab(java.lang.String fileName,
               CrontabEntry.ParseSpec[] style)
        throws java.io.IOException,
               CrontabParseException,
               CrontabEmptyException

Crontab

public Crontab(java.io.BufferedReader reader,
               CrontabEntry.ParseSpec[] style)
        throws java.io.IOException,
               CrontabParseException,
               CrontabEmptyException

Crontab

public Crontab()

Method Detail

getSchedule

public java.util.Collection getSchedule()

Returns:

collection of CrontabEntryInterface objects

parseFromFile

public void parseFromFile(java.lang.String fileName,
                          CrontabEntry.ParseSpec[] style)
                   throws CrontabParseException,
                          CrontabEmptyException,
                          java.io.FileNotFoundException,
                          java.io.IOException

Reads the crontab from a file and converts it to the internal representation

Throws:

CrontabParseException - Error parsing file

CrontabEmptyException

java.io.FileNotFoundException

java.io.IOException

parse

public void parse(java.io.BufferedReader reader,
                  CrontabEntry.ParseSpec[] style)
           throws CrontabParseException,
                  CrontabEmptyException,
                  java.io.IOException

Reads the crontab and converts it to the internal representation The reader can come from any source. Use a StringReader to convert from a String for example.

Parameters:

reader - an input stream for the crontab file.

Throws:

CrontabParseException - Error parsing file

CrontabEmptyException

java.io.IOException

parseLine

public void parseLine(java.lang.String line,
                      CrontabEntry.ParseSpec[] style)
               throws CrontabParseException,
                      CrontabEmptyException

CrontabParseException

CrontabEmptyException

newCrontabEntry

protected CrontabEntry newCrontabEntry(java.lang.String str,
                                       CrontabEntry.ParseSpec[] style)
                                throws CrontabParseException,
                                       CrontabEmptyException

We make this a separate method in case someone wants to inherit and redefine it to return something that inherits from CrontabEntry.

CrontabParseException

CrontabEmptyException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object