CalendarSchedule (ATG Java API)

java.lang.Object
- atg.service.scheduler.CalendarSchedule

All Implemented Interfaces:

Schedule, java.io.Serializable
```
public class CalendarSchedule
extends java.lang.Object
implements Schedule, java.io.Serializable
```
A CalendarSchedule expresses a repeating job in terms of months, days, hours, and minutes. For example, a CalendarSchedule might specify that a job take place on the 15th and 30th of every month, at 3:05am. A CalendarSchedule may also express a day in terms of day of the week, so that a job could take place every Monday in February at 2:30pm.
A CalendarSchedule is built by constructing a blank CalendarSchedule, then adding months, dates, days of the week, occurrences of days of the week in the month, hours, and minutes. Any times matching some combination of the added times will trigger the job. Specifically, the job will be triggered if:
- The current month matches one of the added months, AND
- One of the following is true:
  - The current day of the month matches one of the added dates of the month, OR
  - The current day of the week matches one of the added days of the week, AND its occurrence in the month matches one of the added occurrences
  AND
- The current hour matches one of the added hours, AND
- The current minute matches one of the added minutes
The numerical values for the months, days, days of the week, hours, and minutes correspond to the same values used by the java.util.Calendar class fields MONTH, DATE, DAY_OF_WEEK, HOUR_OF_DAY, and MINUTE. The numerical values 1-4 for the occurrence of day of the week in the month similarly correspond to the values used by the Calendar field DAY_OF_WEEK_IN_MONTH; the special value of "last" is used to indicate the last occurrence in the month (e.g., last Monday of the month).
A CalendarSchedule may also be specified through a String, which the CalendarSchedule will parse. The String is of the form:
```
 "<months> <dates> <days of week> <occurrences in month> <hours of day> <minutes>"
 
```
Each of the above elements, such as <dates>, is specified as one of the following:
- A comma-separated list of numbers, such as "1,15"
- A comma-separated list of ranges, such as "1-12,14-16"
- A mixture of the above, such as "1,2,3,7-12"
- A "*", indicating all numbers
- A ".", indicating no numbers
For example, the following String specifies a job that will occur at 3:05pm on the 1st and 15th of every month:
```
"* 1,15 . . 15 5"
```
The following String specifies a job that will occur at midnight every Monday in the summer and winter:
```
"11-2,5-7 . 2 * 0 0"
```
And the following String specifies a job that will occur every hour on the hour on the first and last Wednesdays of every month:
```
"* . 4 1,last * 0"
```
See java.util.Calendar for more information.
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string
`static int`	`LAST` Represents the last occurrence of day of the week in the month
`static java.lang.String`	`LAST_STRING` The string corresponding to the LAST value
`static java.lang.String`	`MAP_KEY_DAYS_OF_MONTH` Map key for the days of month specifier: "daysOfMonth"
`static java.lang.String`	`MAP_KEY_DAYS_OF_WEEK` Map key for the days of week specifier: "daysOfWeek"
`static java.lang.String`	`MAP_KEY_HOURS` Map key for the hours of day specifier: "hours"
`static java.lang.String`	`MAP_KEY_LOCALE` Map key for the locale: "locale"
`static java.lang.String`	`MAP_KEY_MINUTES` Map key for the minutes specifier: "minutes"
`static java.lang.String`	`MAP_KEY_MONTHS` Map key for the months specifier: "months"
`static java.lang.String`	`MAP_KEY_OCCURRENCES_IN_MONTHS` Map key for the occurrences specifier: "occurrences"
`static java.lang.String`	`MAP_KEY_PARSE_STRING` Map key for entire parse string: "parseString"
`static java.lang.String`	`MAP_KEY_TIMEZONE` Map key for timezone as per TimeZone.getTimeZone(): "timeZone"

Constructor Summary

Constructors
Constructor and Description
`CalendarSchedule()` Constructs a blank new CalendarSchedule using the US locale and the default TimeZone of the JVM.
`CalendarSchedule(java.lang.String pSchedule)` Constructs a new CalendarSchedule parsed from the given String
`CalendarSchedule(java.lang.String pSchedule, java.util.Locale pLocale)` Constructs a new CalendarSchedule parsed from the given String
`CalendarSchedule(java.lang.String pSchedule, java.util.Locale pLocale, java.util.TimeZone pTimeZone)` Constructs a new CalendarSchedule parsed from the given String
`CalendarSchedule(java.lang.String pSchedule, java.util.Locale pLocale, java.util.TimeZone pTimeZone, boolean pDisableDatesInMonthsCheck)` Constructs a new CalendarSchedule parsed from the given String

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CalendarSchedule`	`addAllDates()` Adds all dates to the schedule, so that the job will occur in every date of the month.
`CalendarSchedule`	`addAllDaysOfTheWeek()` Adds all days of the week to the schedule, so that the job will occur in every day of the week.
`CalendarSchedule`	`addAllHours()` Adds all hours to the schedule, so that the job will occur in every hour.
`CalendarSchedule`	`addAllMinutes()` Adds all minutes to the schedule, so that the job will occur in every minute.
`CalendarSchedule`	`addAllMonths()` Adds all months to the schedule, so that the job will occur in every month.
`CalendarSchedule`	`addAllOccurrencesInTheMonth()` Adds all occurrences of day of the week in the month to the schedule, so that the job will occur at every occurrence of day of the week in the month.
`CalendarSchedule`	`addDate(int pDate)` Adds the specified day of the month to the schedule (1-31).
`CalendarSchedule`	`addDayOfTheWeek(int pDayOfTheWeek)` Adds the specified day of the week to the schedule (1=Sunday, 7=Saturday)
`CalendarSchedule`	`addHour(int pHour)` Adds the specified hour to the schedule (0-23, 0=midnight).
`CalendarSchedule`	`addMinute(int pMinute)` Adds the specified minute to the schedule (0-59).
`CalendarSchedule`	`addMonth(int pMonth)` Adds the specified month to the schedule (0=January, 11=December)
`CalendarSchedule`	`addOccurrenceInTheMonth(int pOccurrence)` Adds the specified occurrence of day of the week in the month to the schedule (1=first, 4=fourth, LAST=last)
`protected java.lang.StringBuilder`	`appendRangeString(java.lang.StringBuilder pBuffer, boolean[] pValues)`
`boolean`	`equals(java.lang.Object pObject)` Returns true if the given object is a CalendarSchedule with all the same settings as this schedule.
`java.lang.String`	`generateParseString(java.util.Locale pLocale)` called by scheduleString to generate a new schedule string when the user modifes our properties on the fly.
`java.lang.String`	`generateParseString(java.util.Locale pLocale, boolean pAllowRangeSyntax)` called by scheduleString to generate a new schedule string when the user modifes our properties on the fly.
`java.lang.String`	`generateParseStringFromMap(java.util.Map<java.lang.String,java.lang.Object> pMap)` Generate a parse string from the component entries of the specified map.
`java.lang.String`	`generateStringRepresentation(boolean[] pArray, int startIndex)` represents the array as a string object to be embedded in the scheduleString.
`java.lang.String`	`generateStringRepresentation(boolean[] pArray, int startIndex, boolean pAllowRangeSyntax)` represents the array as a string object to be embedded in the scheduleString.
`boolean[]`	`getAllDates()` gets all dates of the month to the schedule will occur in.
`boolean[]`	`getAllDaysOfTheWeek()` gets all days of the the week the schedule will occur in the zero'th entry can be ignored as counting starts at 1
`boolean[]`	`getAllHours()` gets all hours the schedule will occur in
`boolean[]`	`getAllMinutes()` gets all minutes schedule will occur in
`boolean[]`	`getAllMonths()` gets all months to the schedule will occur in
`boolean[]`	`getAllOccurencesInTheMonth()` Deprecated. Use the correctly spelled getAllOccurrencesInTheMonth(), instead.
`boolean[]`	`getAllOccurrencesInTheMonth()` gets all occurrences in the month the schedule will occur in the zero'th entry can be ignored as counting starts at 1
`java.util.Map<java.lang.String,java.lang.Object>`	`getMapRepresentation(java.util.Locale pLocale)` Generate a map representation.
`long`	`getNextJobTime()` Return the next job time.
`long`	`getNextJobTime(long pLastOccurrenceTime)` Returns the next time that the job Scheduled by this will take place, or -1 if the job's next time could not be calculated.
`java.util.Date`	`getNextJobTimeAsDate()` Return the next job time as a date.
`static java.util.ResourceBundle`	`getResources(java.util.Locale pLocale)`
`java.lang.String`	`getSchedule()` Return the schedule string.
`java.util.TimeZone`	`getTimeZone()` Return the TimeZone used by this scheduler.
`int`	`hashCode()` Returns a hash code value for this object.
`boolean`	`isDisableDatesInMonthsCheck()` Returns property disableDatesInMonthsCheck.
`boolean`	`isEveryMinute()` Return true if the schedule specifies every minute.
`boolean`	`isRepeating()` Returns true if this is a repeating job, false if this is a one-shot job.
`boolean`	`jobOccursAtTime(java.util.Date pTime)` Returns true if the given time is one of the times that the job Scheduled by this may take place.
`static void`	`main(java.lang.String[] pArgs)` Testing method
`boolean`	`mustKnowFirstTime()` If true, then the first time getNextJobTime is called it will be called with -1.
`void`	`parse(java.lang.String pSchedule)` Parses a CalendarSchedule from the specified String, adding all the elements specified by that String.
`void`	`parse(java.lang.String pSchedule, java.util.Locale pLocale)` Parses a CalendarSchedule from the specified String, adding all the elements specified by that String.
`protected void`	`reset(boolean[] pValues)` Set all values in pValues to false.
`void`	`resetAll()` Reset the occurences in calendar to none.
`java.lang.String`	`scheduleString()` Returns a Parseable representation of this Schedule.
`java.lang.String`	`scheduleString(java.util.Locale pLocale)` Returns a Parseable representation of this Schedule.
`void`	`setDisableDatesInMonthsCheck(boolean pDisableDatesInMonthsCheck)` Sets property disableDatesInMonthsCheck.
`void`	`setFromMapRepresentation(java.util.Map<java.lang.String,java.lang.Object> pMap)` Set from a map representation (as returned by getMapRepresentation).
`void`	`setMonthNames()`
`void`	`setSchedule(java.lang.String pSchedule)` Set the schedule
`void`	`setTimeZone(java.util.TimeZone pTimeZone)` Set the TimeZone used by this scheduler.
`void`	`setWeekdayNames()`
`java.lang.String`	`toString()`
`java.lang.String`	`toString(java.util.Locale pLocale)` Returns a String representation of this

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - CLASS_VERSION
```
public static java.lang.String CLASS_VERSION
```
    Class version string
  - MAP_KEY_TIMEZONE
```
public static final java.lang.String MAP_KEY_TIMEZONE
```
    Map key for timezone as per TimeZone.getTimeZone(): "timeZone"
    
    See Also:
    
    Constant Field Values
  - MAP_KEY_LOCALE
```
public static final java.lang.String MAP_KEY_LOCALE
```
    Map key for the locale: "locale"
    
    See Also:
    
    Constant Field Values
  - MAP_KEY_MONTHS
```
public static final java.lang.String MAP_KEY_MONTHS
```
    Map key for the months specifier: "months"
    
    See Also:
    
    Constant Field Values
  - MAP_KEY_DAYS_OF_MONTH
```
public static final java.lang.String MAP_KEY_DAYS_OF_MONTH
```
    Map key for the days of month specifier: "daysOfMonth"
    
    See Also:
    
    Constant Field Values
  - MAP_KEY_OCCURRENCES_IN_MONTHS
```
public static final java.lang.String MAP_KEY_OCCURRENCES_IN_MONTHS
```
    Map key for the occurrences specifier: "occurrences"
    
    See Also:
    
    Constant Field Values
  - MAP_KEY_DAYS_OF_WEEK
```
public static final java.lang.String MAP_KEY_DAYS_OF_WEEK
```
    Map key for the days of week specifier: "daysOfWeek"
    
    See Also:
    
    Constant Field Values
  - MAP_KEY_HOURS
```
public static final java.lang.String MAP_KEY_HOURS
```
    Map key for the hours of day specifier: "hours"
    
    See Also:
    
    Constant Field Values
  - MAP_KEY_MINUTES
```
public static final java.lang.String MAP_KEY_MINUTES
```
    Map key for the minutes specifier: "minutes"
    
    See Also:
    
    Constant Field Values
  - MAP_KEY_PARSE_STRING
```
public static final java.lang.String MAP_KEY_PARSE_STRING
```
    Map key for entire parse string: "parseString"
    
    See Also:
    
    Constant Field Values
  - LAST
```
public static final int LAST
```
    Represents the last occurrence of day of the week in the month
    
    See Also:
    
    Constant Field Values
  - LAST_STRING
```
public static final java.lang.String LAST_STRING
```
    The string corresponding to the LAST value
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CalendarSchedule
```
public CalendarSchedule()
```
    Constructs a blank new CalendarSchedule using the US locale and the default TimeZone of the JVM.
  - CalendarSchedule
```
public CalendarSchedule(java.lang.String pSchedule)
```
    Constructs a new CalendarSchedule parsed from the given String
    
    Parameters:
    
    pSchedule - the schedule in crontab-ish format
    
    Throws:
    
    java.lang.IllegalArgumentException - if the string can not be parsed as a CalendarSchedule
  - CalendarSchedule
```
public CalendarSchedule(java.lang.String pSchedule,
                        java.util.Locale pLocale)
```
    Constructs a new CalendarSchedule parsed from the given String
    
    Parameters:
    
    pSchedule - the schedule in crontab-ish format
    
    pLocale - the locale to use. A null value defaults to Locale.US.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the string can not be parsed as a CalendarSchedule
  - CalendarSchedule
```
public CalendarSchedule(java.lang.String pSchedule,
                        java.util.Locale pLocale,
                        java.util.TimeZone pTimeZone)
```
    Constructs a new CalendarSchedule parsed from the given String
    
    Parameters:
    
    pSchedule - the schedule in crontab-ish format
    
    pLocale - the locale to use. A null value defaults to Locale.US.
    
    pTimeZone - the TimeZone to use. A null value means use the default TimeZone of the JVM.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the string can not be parsed as a CalendarSchedule
  - CalendarSchedule
```
public CalendarSchedule(java.lang.String pSchedule,
                        java.util.Locale pLocale,
                        java.util.TimeZone pTimeZone,
                        boolean pDisableDatesInMonthsCheck)
```
    Constructs a new CalendarSchedule parsed from the given String
    
    Parameters:
    
    pSchedule - the schedule in crontab-ish format
    
    pLocale - the locale to use. A null value defaults to Locale.US.
    
    pTimeZone - the TimeZone to use. A null value means use the default TimeZone of the JVM.
    
    pDisableDatesInMonthsCheck - whether to disable the dates in months check.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the string can not be parsed as a CalendarSchedule
- Method Detail
  - getResources
```
public static java.util.ResourceBundle getResources(java.util.Locale pLocale)
```
  - setMonthNames
```
public void setMonthNames()
```
  - setWeekdayNames
```
public void setWeekdayNames()
```
  - getTimeZone
```
public java.util.TimeZone getTimeZone()
```
    Return the TimeZone used by this scheduler.
    
    Returns:
    
    the TimeZone used.
  - setTimeZone
```
public void setTimeZone(java.util.TimeZone pTimeZone)
```
    Set the TimeZone used by this scheduler.
    
    Parameters:
    
    the - TimeZone to be used.
  - addMonth
```
public CalendarSchedule addMonth(int pMonth)
```
    Adds the specified month to the schedule (0=January, 11=December)
    
    Parameters:
    
    pMonth - the month to add
    
    Returns:
    
    this CalendarSchedule
  - addAllMonths
```
public CalendarSchedule addAllMonths()
```
    Adds all months to the schedule, so that the job will occur in every month.
    
    Returns:
    
    this CalendarSchedule
  - getAllMonths
```
public boolean[] getAllMonths()
```
    gets all months to the schedule will occur in
    
    Returns:
    
    all months as an array of booleans
  - addDate
```
public CalendarSchedule addDate(int pDate)
```
    Adds the specified day of the month to the schedule (1-31).
    
    Parameters:
    
    pDate - the date to add
    
    Returns:
    
    this CalendarSchedule
  - addAllDates
```
public CalendarSchedule addAllDates()
```
    Adds all dates to the schedule, so that the job will occur in every date of the month.
    
    Returns:
    
    this CalendarSchedule
  - getAllDates
```
public boolean[] getAllDates()
```
    gets all dates of the month to the schedule will occur in. the zero'th entry can be ignored as counting starts at 1
    
    Returns:
    
    all dates of the month as an array of booleans
  - addDayOfTheWeek
```
public CalendarSchedule addDayOfTheWeek(int pDayOfTheWeek)
```
    Adds the specified day of the week to the schedule (1=Sunday, 7=Saturday)
    
    Parameters:
    
    pDayOfTheWeek - the day of the week to add
    
    Returns:
    
    this CalendarSchedule
  - addAllDaysOfTheWeek
```
public CalendarSchedule addAllDaysOfTheWeek()
```
    Adds all days of the week to the schedule, so that the job will occur in every day of the week.
    
    Returns:
    
    this CalendarSchedule
  - getAllDaysOfTheWeek
```
public boolean[] getAllDaysOfTheWeek()
```
    gets all days of the the week the schedule will occur in the zero'th entry can be ignored as counting starts at 1
    
    Returns:
    
    all the days of the week.
  - addOccurrenceInTheMonth
```
public CalendarSchedule addOccurrenceInTheMonth(int pOccurrence)
```
    Adds the specified occurrence of day of the week in the month to the schedule (1=first, 4=fourth, LAST=last)
    
    Parameters:
    
    pOccurrence - the occurrence in the month to add
    
    Returns:
    
    this CalendarSchedule
  - addAllOccurrencesInTheMonth
```
public CalendarSchedule addAllOccurrencesInTheMonth()
```
    Adds all occurrences of day of the week in the month to the schedule, so that the job will occur at every occurrence of day of the week in the month.
    
    Returns:
    
    this CalendarSchedule
  - getAllOccurencesInTheMonth
```
@Deprecated
public boolean[] getAllOccurencesInTheMonth()
```
    Deprecated. Use the correctly spelled getAllOccurrencesInTheMonth(), instead.
    
    gets all occurrences in the month the schedule will occur in the zero'th entry can be ignored as counting starts at 1
    
    Returns:
    
    all the ocurrences in the month
  - getAllOccurrencesInTheMonth
```
public boolean[] getAllOccurrencesInTheMonth()
```
    gets all occurrences in the month the schedule will occur in the zero'th entry can be ignored as counting starts at 1
    
    Returns:
    
    all the ocurrences in the month
  - addHour
```
public CalendarSchedule addHour(int pHour)
```
    Adds the specified hour to the schedule (0-23, 0=midnight).
    
    Parameters:
    
    pHour - the hour to add
    
    Returns:
    
    this CalendarSchedule
  - addAllHours
```
public CalendarSchedule addAllHours()
```
    Adds all hours to the schedule, so that the job will occur in every hour.
    
    Returns:
    
    this CalendarSchedule
  - getAllHours
```
public boolean[] getAllHours()
```
    gets all hours the schedule will occur in
    
    Returns:
    
    all the hours the schedule will occur in
  - addMinute
```
public CalendarSchedule addMinute(int pMinute)
```
    Adds the specified minute to the schedule (0-59).
    
    Parameters:
    
    pMinute - the minute to add
    
    Returns:
    
    this CalendarSchedule
  - addAllMinutes
```
public CalendarSchedule addAllMinutes()
```
    Adds all minutes to the schedule, so that the job will occur in every minute.
    
    Returns:
    
    this CalendarSchedule
  - getAllMinutes
```
public boolean[] getAllMinutes()
```
    gets all minutes schedule will occur in
    
    Returns:
    
    all the specified minutes for the schedule
  - isEveryMinute
```
public boolean isEveryMinute()
```
    Return true if the schedule specifies every minute.
  - jobOccursAtTime
```
public boolean jobOccursAtTime(java.util.Date pTime)
```
    Returns true if the given time is one of the times that the job Scheduled by this may take place.
    
    Parameters:
    
    pTime - the time to check (to the nearest minute)
    
    Returns:
    
    true if the job occurs at the specified time, false otherwise.
  - getNextJobTime
```
public long getNextJobTime(long pLastOccurrenceTime)
```
    Returns the next time that the job Scheduled by this will take place, or -1 if the job's next time could not be calculated. The time returned will be on or after after the current time, and on or after the next minute after the specified last occurrence time. If the last occurrence time is -1, then this assumes that this is the first time the job is being scheduled today, and will pick the first time in the day that the job should occur.
    
    Specified by:
    
    getNextJobTime in interface Schedule
    
    Parameters:
    
    pLastOccurrenceTime - the last time the job occurred, or -1 if it has not yet occurred.
    
    Returns:
    
    the next time that the job will occur, or -1 if the job's next time could not be calculated.
  - mustKnowFirstTime
```
public boolean mustKnowFirstTime()
```
    If true, then the first time getNextJobTime is called it will be called with -1. Otherwise, the first time getNextJobTime is called it will be called with the current time.
    
    Specified by:
    
    mustKnowFirstTime in interface Schedule
  - isRepeating
```
public boolean isRepeating()
```
    Returns true if this is a repeating job, false if this is a one-shot job.
    
    Specified by:
    
    isRepeating in interface Schedule
  - parse
```
public void parse(java.lang.String pSchedule)
```
    Parses a CalendarSchedule from the specified String, adding all the elements specified by that String.
    
    Parameters:
    
    pSchedule - the schedule string to parse
    
    Throws:
    
    java.lang.IllegalArgumentException - if the string can not be parsed as a CalendarSchedule
  - parse
```
public void parse(java.lang.String pSchedule,
                  java.util.Locale pLocale)
```
    Parses a CalendarSchedule from the specified String, adding all the elements specified by that String.
    
    Parameters:
    
    pSchedule - the schedule string to parse
    
    pLocale - the locale in which to parse the string.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the string can not be parsed as a CalendarSchedule
  - scheduleString
```
public java.lang.String scheduleString()
```
    Description copied from interface: Schedule
    
    Returns a Parseable representation of this Schedule.
    
    Specified by:
    
    scheduleString in interface Schedule
  - scheduleString
```
public java.lang.String scheduleString(java.util.Locale pLocale)
```
    Returns a Parseable representation of this Schedule.
    
    Specified by:
    
    scheduleString in interface Schedule
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - generateParseString
```
public java.lang.String generateParseString(java.util.Locale pLocale)
```
    called by scheduleString to generate a new schedule string when the user modifes our properties on the fly. by calling addHour for example
    
    Parameters:
    
    pLocale - the locale to use
    
    Returns:
    
    the string representation in the specified Locale
  - generateParseString
```
public java.lang.String generateParseString(java.util.Locale pLocale,
                                            boolean pAllowRangeSyntax)
```
    called by scheduleString to generate a new schedule string when the user modifes our properties on the fly. by calling addHour for example
    
    Parameters:
    
    pLocale - the locale to use
    
    Returns:
    
    the string representation in the specified Locale
  - generateStringRepresentation
```
public java.lang.String generateStringRepresentation(boolean[] pArray,
                                                     int startIndex)
```
    represents the array as a string object to be embedded in the scheduleString.
    
    Parameters:
    
    pArray - the source array of booleans
    
    startIndex - the index at which to start
    
    Returns:
    
    a string representing the range
  - generateStringRepresentation
```
public java.lang.String generateStringRepresentation(boolean[] pArray,
                                                     int startIndex,
                                                     boolean pAllowRangeSyntax)
```
    represents the array as a string object to be embedded in the scheduleString.
    
    Parameters:
    
    pArray - the source array of booleans
    
    startIndex - the index at which to start
    
    Returns:
    
    a string representing the range
  - toString
```
public java.lang.String toString(java.util.Locale pLocale)
```
    Returns a String representation of this
    
    Parameters:
    
    pLocale - the locale to use
    
    Returns:
    
    A string representation of the schedule in the specified locale.
  - appendRangeString
```
protected java.lang.StringBuilder appendRangeString(java.lang.StringBuilder pBuffer,
                                                    boolean[] pValues)
```
  - equals
```
public boolean equals(java.lang.Object pObject)
```
    Returns true if the given object is a CalendarSchedule with all the same settings as this schedule.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for this object.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - main
```
public static void main(java.lang.String[] pArgs)
```
    Testing method
    
    Parameters:
    
    pArgs - the command line arguments
  - setFromMapRepresentation
```
public void setFromMapRepresentation(java.util.Map<java.lang.String,java.lang.Object> pMap)
```
    Set from a map representation (as returned by getMapRepresentation). Note that if a MAP_KEY_PARSE_STRING ("parseString") entry is present in the map, it will be used in preference to individual map entries, such as MAP_KEY_HOURS("hours"). MAP_KEY_LOCALE and MAP_KEY_TIMEZONE are always considered if present.
    For a complete list of avialable map keys, see the MAP_KEY_* constants on this class.
    
    Parameters:
    
    pMap - the source map.
  - generateParseStringFromMap
```
public java.lang.String generateParseStringFromMap(java.util.Map<java.lang.String,java.lang.Object> pMap)
```
    Generate a parse string from the component entries of the specified map. Any existing parseString entry in the map will be ingored.
    
    Parameters:
    
    pMap - the map from which to geneerate a parse string.
    
    Returns:
    
    a parse string
  - getMapRepresentation
```
public java.util.Map<java.lang.String,java.lang.Object> getMapRepresentation(java.util.Locale pLocale)
```
    Generate a map representation.
    
    Parameters:
    
    pLocale - the locale in which to generate a map implementation
    
    Returns:
    
    a map representing the schedule.
  - resetAll
```
public void resetAll()
```
    Reset the occurences in calendar to none. May be called before "parse" to only allow occurrences from that parse (otherwise, they are additive).
  - reset
```
protected void reset(boolean[] pValues)
```
    Set all values in pValues to false.
    
    Parameters:
    
    pValues - the values the set to null.
  - setDisableDatesInMonthsCheck
```
public void setDisableDatesInMonthsCheck(boolean pDisableDatesInMonthsCheck)
```
    Sets property disableDatesInMonthsCheck. Disable the check to make sure any specified date falls in at least one of the specified months.
  - isDisableDatesInMonthsCheck
```
public boolean isDisableDatesInMonthsCheck()
```
    Returns property disableDatesInMonthsCheck. Disable the check to make sure any specified date falls in at least one of the specified months.
  - getSchedule
```
public java.lang.String getSchedule()
```
    Return the schedule string.
  - setSchedule
```
public void setSchedule(java.lang.String pSchedule)
```
    Set the schedule
  - getNextJobTime
```
public long getNextJobTime()
```
    Return the next job time.
  - getNextJobTimeAsDate
```
public java.util.Date getNextJobTimeAsDate()
```
    Return the next job time as a date.

Class CalendarSchedule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

MAP_KEY_TIMEZONE

MAP_KEY_LOCALE

MAP_KEY_MONTHS

MAP_KEY_DAYS_OF_MONTH

MAP_KEY_OCCURRENCES_IN_MONTHS

MAP_KEY_DAYS_OF_WEEK

MAP_KEY_HOURS

MAP_KEY_MINUTES

MAP_KEY_PARSE_STRING

LAST

LAST_STRING

Constructor Detail

CalendarSchedule

CalendarSchedule

CalendarSchedule

CalendarSchedule

CalendarSchedule

Method Detail

getResources

setMonthNames

setWeekdayNames

getTimeZone

setTimeZone

addMonth

addAllMonths

getAllMonths

addDate

addAllDates

getAllDates

addDayOfTheWeek

addAllDaysOfTheWeek

getAllDaysOfTheWeek

addOccurrenceInTheMonth

addAllOccurrencesInTheMonth

getAllOccurencesInTheMonth

getAllOccurrencesInTheMonth

addHour

addAllHours

getAllHours

addMinute

addAllMinutes

getAllMinutes

isEveryMinute

jobOccursAtTime

getNextJobTime

mustKnowFirstTime

isRepeating

parse

parse

scheduleString

scheduleString

toString

generateParseString

generateParseString

generateStringRepresentation

generateStringRepresentation

toString

appendRangeString

equals

hashCode

main

setFromMapRepresentation

generateParseStringFromMap

getMapRepresentation

resetAll

reset

setDisableDatesInMonthsCheck

isDisableDatesInMonthsCheck

getSchedule

setSchedule

getNextJobTime

getNextJobTimeAsDate