org.oddjob.schedules

Class CalendarUtils

java.lang.Object

org.oddjob.schedules.CalendarUtils

public class CalendarUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CalendarUtils(java.util.Calendar baseCalendar) Constructor base on an existing calendar.
CalendarUtils(java.util.Date inDate, java.util.TimeZone timeZone) Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Calendar	dayOfMonth(DayOfMonth dayOfMonth) Utility function to get a calendar which represents the day of the month in which the reference date is.
java.util.Calendar	dayOfWeek(DayOfWeek dayOfWeek) Utility function to get a calendar which represents the day of the week from the reference date.
java.util.Calendar	dayOfWeekInMonth(DayOfWeek dayOfWeek, WeekOfMonth week)
java.util.Calendar	dayOfYear(int dayOfMonth, int month) Calendar for the day of year.
java.util.Calendar	endOfDay() Calculate start of the day after.
java.util.Calendar	endOfMonth() Calculate the date at the end of the month for the given date.
static java.util.Calendar	endOfWeek(java.util.Date inDate, java.util.TimeZone timeZone) Calculate the start of the week for the given date.
java.util.Calendar	endOfWeekOfMonth(WeekOfMonth week)
static java.util.Calendar	endOfYear(java.util.Date referenceDate, java.util.TimeZone timeZone) Calcuate the date at the end of the year from the given date.
java.util.Calendar	forDate(java.util.Date date) Return a new calendar with the base calendar time zone but a different date.
static java.util.Calendar	monthOfYear(java.util.Date referenceDate, int month, java.util.TimeZone timeZone) Utility function to get the start of the month as a Calendar.
static void	setEndOfDay(java.util.Calendar calendar) Set the calendar to the end of day.
static void	setEndOfMonth(java.util.Calendar calendar) Set the calendar to the end of the month.
java.util.Calendar	startOfDay() Calculate the start of day date time (i.e.
java.util.Calendar	startOfMonth() Calculate the date at the start of the month for the given date.
static java.util.Calendar	startOfWeek(java.util.Date inDate, java.util.TimeZone timeZone) Calculate the start of the week for the given date.
java.util.Calendar	startOfWeekOfMonth(WeekOfMonth week)
static java.util.Calendar	startOfYear(java.util.Date referenceDate, java.util.TimeZone timeZone) Calculate the date at the start of the year for the given date.

Methods inherited from class java.lang.Object

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

Constructor Detail

CalendarUtils

public CalendarUtils(java.util.Date inDate,
                     java.util.TimeZone timeZone)

Constructor.

Parameters:

inDate - The date to base functionality on.

timeZone - The timezone for the calendar

CalendarUtils

public CalendarUtils(java.util.Calendar baseCalendar)

Constructor base on an existing calendar.

Parameters:

baseCalendar -

Method Detail

forDate

public java.util.Calendar forDate(java.util.Date date)

Return a new calendar with the base calendar time zone but a different date.

Parameters:

date - The date.

Returns:

The new calendar.

startOfDay

public java.util.Calendar startOfDay()

Calculate the start of day date time (i.e. at 00:00) for a given date.

Returns:

The Calendar at the start of the day.

endOfDay

public java.util.Calendar endOfDay()

Calculate start of the day after.

Returns:

The Calendar at the start of the next day.

setEndOfDay

public static void setEndOfDay(java.util.Calendar calendar)

Set the calendar to the end of day.

Parameters:

calendar - The calendar that will be set.

setEndOfMonth

public static void setEndOfMonth(java.util.Calendar calendar)

Set the calendar to the end of the month.

Parameters:

calendar - The calendar that will be set.

startOfMonth

public java.util.Calendar startOfMonth()

Calculate the date at the start of the month for the given date.

Returns:

The date at the start of the month.

endOfMonth

public java.util.Calendar endOfMonth()

Calculate the date at the end of the month for the given date.

Returns:

The calendar at the end of the month.

dayOfMonth

public java.util.Calendar dayOfMonth(DayOfMonth dayOfMonth)

Utility function to get a calendar which represents the day of the month in which the reference date is.

Parameters:

day - The day.

Returns:

The Calendar.

startOfWeekOfMonth

public java.util.Calendar startOfWeekOfMonth(WeekOfMonth week)

endOfWeekOfMonth

public java.util.Calendar endOfWeekOfMonth(WeekOfMonth week)

dayOfWeekInMonth

public java.util.Calendar dayOfWeekInMonth(DayOfWeek dayOfWeek,
                                           WeekOfMonth week)

startOfWeek

public static java.util.Calendar startOfWeek(java.util.Date inDate,
                                             java.util.TimeZone timeZone)

Calculate the start of the week for the given date.

Parameters:

inDate - The given date.

Returns:

The date at the start of the month.

endOfWeek

public static java.util.Calendar endOfWeek(java.util.Date inDate,
                                           java.util.TimeZone timeZone)

Calculate the start of the week for the given date.

Parameters:

inDate - The given date.

Returns:

The date at the start of the month.

dayOfWeek

public java.util.Calendar dayOfWeek(DayOfWeek dayOfWeek)

Utility function to get a calendar which represents the day of the week from the reference date.

Parameters:

day - The day.

startOfYear

public static java.util.Calendar startOfYear(java.util.Date referenceDate,
                                             java.util.TimeZone timeZone)

Calculate the date at the start of the year for the given date.

Parameters:

referenceDate - The given date.

Returns:

The calendar at the start of the year.

endOfYear

public static java.util.Calendar endOfYear(java.util.Date referenceDate,
                                           java.util.TimeZone timeZone)

Calcuate the date at the end of the year from the given date.

Parameters:

referenceDate - The given date.

Returns:

The calendar at the end of the year.

dayOfYear

public java.util.Calendar dayOfYear(int dayOfMonth,
                                    int month)

Calendar for the day of year.

Parameters:

referenceDate - The date to take year from.

dayOfYear - The day of the year.

Returns:

The calendar.

monthOfYear

public static java.util.Calendar monthOfYear(java.util.Date referenceDate,
                                             int month,
                                             java.util.TimeZone timeZone)

Utility function to get the start of the month as a Calendar.

Parameters:

referenceDate - The whole date.

month - The month to calculate the start of. 1 is January, 12 is December.

Returns:

The start of the month.