Class Entry

java.lang.Object
   |
   +----DayPlanParser
           |
           +----Entry

public class Entry
extends DayPlanParser

Entry is an object for keeping information about an appointment. An appointment is referred to as an Entry in the plan(4) man page. Several interface routines are provided in this class for determining the start and end time of an appointment, as well as any notes or messages associated with the appointment.

See Also:: DayPlanParser

Entry(String): Creates a new Entry object, initialized to the data found on the given line.

addExceptionDate(String): Adds an exception date to the Entry.
addGroup(String): Adds a group to the Entry.
addMessage(String): Adds a message to the Entry.
addNote(String): Adds a note to the Entry.
addRepetitionInfo(String): Adds repetition info to the Entry.
addScript(String): Adds a script to the Entry.
getEndTime(): Returns the ending time of this appointment.
getMessage(): Returns a new String representing with the note and messages associated with this Entry.
getStartTime(): Returns the starting time of this appointment.
toString(): Returns a String representing this Entry (triggerDate, startTime, and endTime).

Entry

  public Entry(String line) throws EntryException

Creates a new Entry object, initialized to the data found on the given line. This is the first line for the Entry, which contains the triggerDate, startTime, endTime, etc. See plan(4) for more info.

Parameters:: line - the line to parse for the group
Throws: EntryException: when there is an error in reading info
See Also:: String

getStartTime

  public Time getStartTime()

Returns the starting time of this appointment.

Returns:: a Time object representing the starting time
See Also:: Time

getEndTime

  public Time getEndTime()

Returns the ending time of this appointment.

Returns:: a Time object representing the ending time
See Also:: Time

toString

  public String toString()

Returns a String representing this Entry (triggerDate, startTime, and endTime).

Overrides:: toString in class Object
See Also:: String

getMessage

  public String getMessage()

Returns a new String representing with the note and messages associated with this Entry.

See Also:: String

addExceptionDate

  public void addExceptionDate(String line) throws EntryException

Adds an exception date to the Entry. See plan(4) for more info.

Parameters:: line - the line to parse for the exception date
Throws: EntryException: when there is an error in reading info
See Also:: String

addRepetitionInfo

  public void addRepetitionInfo(String line) throws EntryException

Adds repetition info to the Entry. See plan(4) for more info.

Parameters:: line - the line to parse for the repetition info
Throws: EntryException: when there is an error in reading info
See Also:: String, Repetition

addNote

  public void addNote(String line) throws EntryException

Adds a note to the Entry. See plan(4) for more info.

Parameters:: line - the line to parse for the note
Throws: EntryException: when there is an error in reading info
See Also:: String

addMessage

  public void addMessage(String line) throws EntryException

Adds a message to the Entry. See plan(4) for more info.

Parameters:: line - the line to parse for the message
Throws: EntryException: when there is an error in reading info
See Also:: String

addScript

  public void addScript(String line) throws EntryException

Adds a script to the Entry. See plan(4) for more info.

Parameters:: line - the line to parse for the script
Throws: EntryException: when there is an error in reading info
See Also:: String

addGroup

  public void addGroup(String line) throws EntryException

Adds a group to the Entry. See plan(4) for more info.

Parameters:: line - the line to parse for the group
Throws: EntryException: when there is an error in reading info
See Also:: String