com.joestelmach.natty

Class WalkerState

java.lang.Object

com.joestelmach.natty.WalkerState

public class WalkerState
extends Object

Author:

Joe Stelmach

Constructor Summary

Constructors

Constructor and Description
WalkerState() Creates a new WalkerState representing the start of the next hour from the current time

Method Summary

Methods

Modifier and Type	Method and Description
void	captureDateTime()
void	clearDateGroup() Clears any date/times that have been captured
protected GregorianCalendar	getCalendar()
DateGroup	getDateGroup()
void	seekBySpan(String direction, String seekAmount, String span) seeks by a span of time (weeks, months, etc)
void	seekToDayOfMonth(String dayOfMonth) Seeks to the given day within the current month
void	seekToDayOfWeek(String direction, String seekType, String seekAmount, String dayOfWeek) seeks to a specified day of the week in the past or future.
void	seekToDayOfYear(String dayOfYear) Seeks to the given day within the current year
void	seekToHoliday(String holidayString, String direction, String seekAmount) Seeks forward or backwards to a particular holiday based on the current date
void	seekToHolidayYear(String holidayString, String yearString) Seeks to the given holiday within the given year
void	seekToMonth(String direction, String seekAmount, String month) seeks to a particular month
void	seekToSeason(String seasonString, String direction, String seekAmount) Seeks forward or backwards to a particular season based on the current date
void	seekToSeasonYear(String seasonString, String yearString) Seeks to the given season within the given year
void	seekToYear(String year)
void	setDayOfWeekIndex(String index, String dayOfWeek)
void	setDefaultTimeZone(TimeZone zone)
void	setExplicitDate(String month, String dayOfMonth, String dayOfWeek, String year)
void	setExplicitTime(String hours, String minutes, String seconds, String amPm, String zoneString) Sets the the time of day
void	setRecurring()

Methods inherited from class java.lang.Object

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

Constructor Detail

WalkerState

public WalkerState()

Creates a new WalkerState representing the start of the next hour from the current time

Method Detail

setDefaultTimeZone

public void setDefaultTimeZone(TimeZone zone)

seekToDayOfWeek

public void seekToDayOfWeek(String direction,
                   String seekType,
                   String seekAmount,
                   String dayOfWeek)

seeks to a specified day of the week in the past or future.

Parameters:

direction - the direction to seek: two possibilities '<' go backward '>' go forward

seekType - the type of seek to perform (by_day or by_week) by_day means we seek to the very next occurrence of the given day by_week means we seek to the first occurrence of the given day week in the next (or previous,) week (or multiple of next or previous week depending on the seek amount.)

seekAmount - the amount to seek. Must be guaranteed to parse as an integer

dayOfWeek - the day of the week to seek to, represented as an integer from 1 to 7 (1 being Sunday, 7 being Saturday.) Must be guaranteed to parse as an Integer

seekToDayOfMonth

public void seekToDayOfMonth(String dayOfMonth)

Seeks to the given day within the current month

Parameters:

dayOfMonth - the day of the month to seek to, represented as an integer from 1 to 31. Must be guaranteed to parse as an Integer. If this day is beyond the last day of the current month, the actual last day of the month will be used.

seekToDayOfYear

public void seekToDayOfYear(String dayOfYear)

Seeks to the given day within the current year

Parameters:

dayOfYear - the day of the year to seek to, represented as an integer from 1 to 366. Must be guaranteed to parse as an Integer. If this day is beyond the last day of the current year, the actual last day of the year will be used.

seekToYear

public void seekToYear(String year)

Parameters:

year -

seekToMonth

public void seekToMonth(String direction,
               String seekAmount,
               String month)

seeks to a particular month

Parameters:

direction - the direction to seek: two possibilities '<' go backward '>' go forward

seekAmount - the amount to seek. Must be guaranteed to parse as an integer

month - the month to seek to. Must be guaranteed to parse as an integer between 1 and 12

seekBySpan

public void seekBySpan(String direction,
              String seekAmount,
              String span)

seeks by a span of time (weeks, months, etc)

Parameters:

direction - the direction to seek: two possibilities '<' go backward '>' go forward

seekAmount - the amount to seek. Must be guaranteed to parse as an integer

span -

setDayOfWeekIndex

public void setDayOfWeekIndex(String index,
                     String dayOfWeek)

Parameters:

index -

dayOfWeek -

setExplicitDate

public void setExplicitDate(String month,
                   String dayOfMonth,
                   String dayOfWeek,
                   String year)

Parameters:

month - the month to set. Must be guaranteed to parse as an integer between 1 and 12

dayOfMonth - the day of month to set. Must be guaranteed to parse as an integer between 1 and 31

dayOfWeek - the day of the week. This is optional and will only be used when no year is given. If the current year's month and day does not fall on the given day of week, we walk backwards in 1 year iterations until we find the first such date. If given, must be guaranteed to parse as an integer between 1 and 7.

year - the year to set (optional). If present, must be guaranteed to parse as an integer between 0 and 9999

setExplicitTime

public void setExplicitTime(String hours,
                   String minutes,
                   String seconds,
                   String amPm,
                   String zoneString)

Sets the the time of day

Parameters:

hours - the hours to set. Must be guaranteed to parse as an integer between 0 and 23

minutes - the minutes to set. Must be guaranteed to parse as an integer between 0 and 59

seconds - the optional seconds to set. Must be guaranteed to parse as an integer between 0 and 59

amPm - the meridian indicator to use. Must be either 'am' or 'pm'

zoneString - the time zone to use in one of two formats: - zoneinfo format (America/New_York, America/Los_Angeles, etc) - GMT offset (+05:00, -0500, +5, etc)

seekToHoliday

public void seekToHoliday(String holidayString,
                 String direction,
                 String seekAmount)

Seeks forward or backwards to a particular holiday based on the current date

Parameters:

holidayString - The holiday to seek to

direction - The direction to seek

seekAmount - The number of years to seek

seekToHolidayYear

public void seekToHolidayYear(String holidayString,
                     String yearString)

Seeks to the given holiday within the given year

Parameters:

holidayString -

yearString -

seekToSeason

public void seekToSeason(String seasonString,
                String direction,
                String seekAmount)

Seeks forward or backwards to a particular season based on the current date

Parameters:

seasonString - The season to seek to

direction - The direction to seek

seekAmount - The number of years to seek

seekToSeasonYear

public void seekToSeasonYear(String seasonString,
                    String yearString)

Seeks to the given season within the given year

Parameters:

seasonString -

yearString -

setRecurring

public void setRecurring()

captureDateTime

public void captureDateTime()

getDateGroup

public DateGroup getDateGroup()

Returns:

the list of date times found

clearDateGroup

public void clearDateGroup()

Clears any date/times that have been captured

getCalendar

protected GregorianCalendar getCalendar()

Returns:

the current calendar