prompt.csv.utils

Class CalendarUtil

java.lang.Object

prompt.csv.utils.CalendarUtil

public final class CalendarUtil
extends java.lang.Object

Useful Calendar utilities.

Author:

BalusC

Method Summary

Methods

Modifier and Type	Method and Description
static void	addDays(java.util.Calendar calendar, int days) Add the given amount of days to the given calendar.
static void	addHours(java.util.Calendar calendar, int hours) Add the given amount of hours to the given calendar.
static void	addMillis(java.util.Calendar calendar, int millis) Add the given amount of millis to the given calendar.
static void	addMinutes(java.util.Calendar calendar, int minutes) Add the given amount of minutes to the given calendar.
static void	addMonths(java.util.Calendar calendar, int months) Add the given amount of months to the given calendar.
static void	addSeconds(java.util.Calendar calendar, int seconds) Add the given amount of seconds to the given calendar.
static void	addYears(java.util.Calendar calendar, int years) Add the given amount of years to the given calendar.
static int	elapsedDays(java.util.Calendar before, java.util.Calendar after) Retrieve the amount of elapsed days between the two given calendars.
static int	elapsedHours(java.util.Calendar before, java.util.Calendar after) Retrieve the amount of elapsed hours between the two given calendars.
static long	elapsedMillis(java.util.Calendar before, java.util.Calendar after) Retrieve the amount of elapsed milliseconds between the two given calendars.
static int	elapsedMinutes(java.util.Calendar before, java.util.Calendar after) Retrieve the amount of elapsed minutes between the two given calendars.
static int	elapsedMonths(java.util.Calendar before, java.util.Calendar after) Retrieve the amount of elapsed months between the two given calendars.
static int	elapsedSeconds(java.util.Calendar before, java.util.Calendar after) Retrieve the amount of elapsed seconds between the two given calendars.
static int[]	elapsedTime(java.util.Calendar before, java.util.Calendar after) Calculate the total of elapsed time from years up to seconds between the two given calendars.
static int	elapsedYears(java.util.Calendar before, java.util.Calendar after) Retrieve the amount of elapsed years between the two given calendars.
static java.util.Calendar	getValidCalendar(int year, int month, int day) Validate the actual date of the given date elements and returns a calendar instance based on the given date elements.
static java.util.Calendar	getValidCalendar(int year, int month, int day, int hour, int minute, int second) Validate the actual date of the given date elements and returns a calendar instance based on the given date elements.
static boolean	isValidDate(int year, int month, int day) Checks whether the given day, month and year combination is a valid date or not.
static boolean	isValidDate(int year, int month, int day, int hour, int minute, int second) Checks whether the given day, month, year, hour, minute and second combination is a valid date or not.
static boolean	isValidTime(int hour, int minute, int second) Checks whether the given hour, minute and second combination is a valid time or not.
static boolean	sameDay(java.util.Calendar one, java.util.Calendar two) Returns true if the two given calendars are dated on the same year, month and day.
static boolean	sameHour(java.util.Calendar one, java.util.Calendar two) Returns true if the two given calendars are dated on the same year, month, day and hour.
static boolean	sameMinute(java.util.Calendar one, java.util.Calendar two) Returns true if the two given calendars are dated on the same year, month, day, hour and minute.
static boolean	sameMonth(java.util.Calendar one, java.util.Calendar two) Returns true if the two given calendars are dated on the same year and month.
static boolean	sameSecond(java.util.Calendar one, java.util.Calendar two) Returns true if the two given calendars are dated on the same year, month, day, hour, minute and second.
static boolean	sameTime(java.util.Calendar one, java.util.Calendar two) Returns true if the two given calendars are dated on the same time.
static boolean	sameYear(java.util.Calendar one, java.util.Calendar two) Returns true if the two given calendars are dated on the same year.

Methods inherited from class java.lang.Object

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

Method Detail

isValidDate

public static boolean isValidDate(int year,
                  int month,
                  int day)

Checks whether the given day, month and year combination is a valid date or not.

Parameters:

year - The year part of the date.

month - The month part of the date.

day - The day part of the date.

Returns:

True if the given day, month and year combination is a valid date.

isValidTime

public static boolean isValidTime(int hour,
                  int minute,
                  int second)

Checks whether the given hour, minute and second combination is a valid time or not.

Parameters:

hour - The hour part of the time.

minute - The minute part of the time.

second - The second part of the time.

Returns:

True if the given hour, minute and second combination is a valid time.

isValidDate

public static boolean isValidDate(int year,
                  int month,
                  int day,
                  int hour,
                  int minute,
                  int second)

Checks whether the given day, month, year, hour, minute and second combination is a valid date or not.

Parameters:

year - The year part of the date.

month - The month part of the date.

day - The day part of the date.

hour - The hour part of the date.

minute - The minute part of the date.

second - The second part of the date.

Returns:

True if the given day, month, year, hour, minute and second combination is a valid date.

getValidCalendar

public static java.util.Calendar getValidCalendar(int year,
                                  int month,
                                  int day)

Validate the actual date of the given date elements and returns a calendar instance based on the given date elements. The time is forced to 00:00:00.

Parameters:

year - The year part of the date.

month - The month part of the date.

day - The day part of the date.

Returns:

A Calendar instance prefilled with the given date elements.

Throws:

java.lang.IllegalArgumentException - If the given date elements does not represent a valid date.

getValidCalendar

public static java.util.Calendar getValidCalendar(int year,
                                  int month,
                                  int day,
                                  int hour,
                                  int minute,
                                  int second)

Validate the actual date of the given date elements and returns a calendar instance based on the given date elements.

Parameters:

year - The year part of the date.

month - The month part of the date.

day - The day part of the date.

hour - The hour part of the date.

minute - The minute part of the date.

second - The second part of the date.

Returns:

A Calendar instance prefilled with the given date elements.

Throws:

java.lang.IllegalArgumentException - If the given date elements does not represent a valid date.

addYears

public static void addYears(java.util.Calendar calendar,
            int years)

Add the given amount of years to the given calendar. The changes are reflected in the given calendar.

Parameters:

calendar - The calendar to add the given amount of years to.

years - The amount of years to be added to the given calendar. Negative values are also allowed, it will just go back in time.

addMonths

public static void addMonths(java.util.Calendar calendar,
             int months)

Add the given amount of months to the given calendar. The changes are reflected in the given calendar.

Parameters:

calendar - The calendar to add the given amount of months to.

months - The amount of months to be added to the given calendar. Negative values are also allowed, it will just go back in time.

addDays

public static void addDays(java.util.Calendar calendar,
           int days)

Add the given amount of days to the given calendar. The changes are reflected in the given calendar.

Parameters:

calendar - The calendar to add the given amount of days to.

days - The amount of days to be added to the given calendar. Negative values are also allowed, it will just go back in time.

addHours

public static void addHours(java.util.Calendar calendar,
            int hours)

Add the given amount of hours to the given calendar. The changes are reflected in the given calendar.

Parameters:

calendar - The calendar to add the given amount of hours to.

hours - The amount of hours to be added to the given calendar. Negative values are also allowed, it will just go back in time.

addMinutes

public static void addMinutes(java.util.Calendar calendar,
              int minutes)

Add the given amount of minutes to the given calendar. The changes are reflected in the given calendar.

Parameters:

calendar - The calendar to add the given amount of minutes to.

minutes - The amount of minutes to be added to the given calendar. Negative values are also allowed, it will just go back in time.

addSeconds

public static void addSeconds(java.util.Calendar calendar,
              int seconds)

Add the given amount of seconds to the given calendar. The changes are reflected in the given calendar.

Parameters:

calendar - The calendar to add the given amount of seconds to.

seconds - The amount of seconds to be added to the given calendar. Negative values are also allowed, it will just go back in time.

addMillis

public static void addMillis(java.util.Calendar calendar,
             int millis)

Add the given amount of millis to the given calendar. The changes are reflected in the given calendar.

Parameters:

calendar - The calendar to add the given amount of millis to.

millis - The amount of millis to be added to the given calendar. Negative values are also allowed, it will just go back in time.

sameYear

public static boolean sameYear(java.util.Calendar one,
               java.util.Calendar two)

Returns true if the two given calendars are dated on the same year.

Parameters:

one - The one calendar.

two - The other calendar.

Returns:

True if the two given calendars are dated on the same year.

sameMonth

public static boolean sameMonth(java.util.Calendar one,
                java.util.Calendar two)

Returns true if the two given calendars are dated on the same year and month.

Parameters:

one - The one calendar.

two - The other calendar.

Returns:

True if the two given calendars are dated on the same year and month.

sameDay

public static boolean sameDay(java.util.Calendar one,
              java.util.Calendar two)

Returns true if the two given calendars are dated on the same year, month and day.

Parameters:

one - The one calendar.

two - The other calendar.

Returns:

True if the two given calendars are dated on the same year, month and day.

sameHour

public static boolean sameHour(java.util.Calendar one,
               java.util.Calendar two)

Returns true if the two given calendars are dated on the same year, month, day and hour.

Parameters:

one - The one calendar.

two - The other calendar.

Returns:

True if the two given calendars are dated on the same year, month, day and hour.

sameMinute

public static boolean sameMinute(java.util.Calendar one,
                 java.util.Calendar two)

Returns true if the two given calendars are dated on the same year, month, day, hour and minute.

Parameters:

one - The one calendar.

two - The other calendar.

Returns:

True if the two given calendars are dated on the same year, month, day, hour and minute.

sameSecond

public static boolean sameSecond(java.util.Calendar one,
                 java.util.Calendar two)

Returns true if the two given calendars are dated on the same year, month, day, hour, minute and second.

Parameters:

one - The one calendar.

two - The other calendar.

Returns:

True if the two given calendars are dated on the same year, month, day, hour, minute and second.

sameTime

public static boolean sameTime(java.util.Calendar one,
               java.util.Calendar two)

Returns true if the two given calendars are dated on the same time. The difference from one.equals(two) is that this method does not respect the time zone.

Parameters:

one - The one calendar.

two - The other calendar.

Returns:

True if the two given calendars are dated on the same time.

elapsedYears

public static int elapsedYears(java.util.Calendar before,
               java.util.Calendar after)

Retrieve the amount of elapsed years between the two given calendars.

Parameters:

before - The first calendar with expected date before the second calendar.

after - The second calendar with expected date after the first calendar.

Returns:

The amount of elapsed years between the two given calendars.

Throws:

java.lang.IllegalArgumentException - If the first calendar is dated after the second calendar.

elapsedMonths

public static int elapsedMonths(java.util.Calendar before,
                java.util.Calendar after)

Retrieve the amount of elapsed months between the two given calendars.

Parameters:

before - The first calendar with expected date before the second calendar.

after - The second calendar with expected date after the first calendar.

Returns:

The amount of elapsed months between the two given calendars.

Throws:

java.lang.IllegalArgumentException - If the first calendar is dated after the second calendar.

elapsedDays

public static int elapsedDays(java.util.Calendar before,
              java.util.Calendar after)

Retrieve the amount of elapsed days between the two given calendars.

Parameters:

before - The first calendar with expected date before the second calendar.

after - The second calendar with expected date after the first calendar.

Returns:

The amount of elapsed days between the two given calendars.

Throws:

java.lang.IllegalArgumentException - If the first calendar is dated after the second calendar.

elapsedHours

public static int elapsedHours(java.util.Calendar before,
               java.util.Calendar after)

Retrieve the amount of elapsed hours between the two given calendars.

Parameters:

before - The first calendar with expected date before the second calendar.

after - The second calendar with expected date after the first calendar.

Returns:

The amount of elapsed hours between the two given calendars.

Throws:

java.lang.IllegalArgumentException - If the first calendar is dated after the second calendar.

elapsedMinutes

public static int elapsedMinutes(java.util.Calendar before,
                 java.util.Calendar after)

Retrieve the amount of elapsed minutes between the two given calendars.

Parameters:

before - The first calendar with expected date before the second calendar.

after - The second calendar with expected date after the first calendar.

Returns:

The amount of elapsed minutes between the two given calendars.

Throws:

java.lang.IllegalArgumentException - If the first calendar is dated after the second calendar.

elapsedSeconds

public static int elapsedSeconds(java.util.Calendar before,
                 java.util.Calendar after)

Retrieve the amount of elapsed seconds between the two given calendars.

Parameters:

before - The first calendar with expected date before the second calendar.

after - The second calendar with expected date after the first calendar.

Returns:

The amount of elapsed seconds between the two given calendars.

Throws:

java.lang.IllegalArgumentException - If the first calendar is dated after the second calendar.

elapsedMillis

public static long elapsedMillis(java.util.Calendar before,
                 java.util.Calendar after)

Retrieve the amount of elapsed milliseconds between the two given calendars.

Parameters:

before - The first calendar with expected date before the second calendar.

after - The second calendar with expected date after the first calendar.

Returns:

The amount of elapsed milliseconds between the two given calendars.

Throws:

java.lang.IllegalArgumentException - If the first calendar is dated after the second calendar.

elapsedTime

public static int[] elapsedTime(java.util.Calendar before,
                java.util.Calendar after)

Calculate the total of elapsed time from years up to seconds between the two given calendars. It returns an int array with the elapsed years, months, days, hours, minutes and seconds respectively.

Parameters:

before - The first calendar with expected date before the second calendar.

after - The second calendar with expected date after the first calendar.

Returns:

The elapsed time between the two given calendars in years, months, days, hours, minutes and seconds.

Throws:

java.lang.IllegalArgumentException - If the first calendar is dated after the second calendar.