to.etc.util

Class DateUtil

java.lang.Object

to.etc.util.DateUtil

public final class DateUtil
extends Object

Static date/time utiility class.

Author:

Frits Jalvingh Created on Feb 28, 2007

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<Calendar>	CALENDAR_TIMES_COMPARATOR Compares calendar times (hours, minutes, seconds and milliseconds) and returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.
static Date	FUTURE A fixed date way into the future.

Method Summary

Modifier and Type	Method and Description
static Date	addDays(Date in, int days)
static Date	addMinutes(Date in, int minutes)
static Date	addMonths(Date in, int months)
static Date	addYears(Date in, int years)
static boolean	between(Date start, Date end, Date v)
static Date	calculateDurationEndInSec(Date start, int durationInSeconds)
static void	clearTime(Calendar cal) Clears the entire time portion of a Calendar.
static Date	convertToDate(String input, String dateFormat) Parses input String to Date class, according to dateFormat argument.
static Date	convertToDate(String input, String dateFormat, boolean lenient) Parses input String to Date class, according to dateFormat argument.
static Date	dateFor(int year, int month, int day)
static Date	dateFor(int year, int month, int day, int hour, int minute, int sec, int mils)
static Date	dateFromDateTime(Date coredate, String timestring) Decraps the separate date / time found in the VP database into a normal date containing the time.
static long	decodeTime(String timestring) Decodes a time string, encoded as hh:mm:ss.mmmm where ss.mmmm are optional.
static int	deltaInDays(Date start, Date end) Get the difference in number of days between the specified dates.
static int	deltaMonths(Date start, Date end)
static Date	dumbEndOfDayDate(Date dt) INTERNAL DAO USE ONLY -- This returns a date/ which ends at 23:59 of the day passed.
static String	encodeTimeInMS(long millis, int nfields, boolean shortest) Quick conversion of time to a string for presentation pps.
static String	extractTimeString(Date dt, int size) Extracts the dumb time field from a date.
static String	formatSafe(Date date, DateFormat format) Returns format for specified date and formatter.
static Calendar	getCalendar() GregorianCalendarFixDutchTime fixes missing date-time in the GregorianCalendar for dutch locale when validating those missing date-times the next valid time will be returned instead of generating an error
static Calendar	getCalendar(Locale aLocale) GregorianCalendarFixDutchTime fixes missing date-time in the GregorianCalendar for dutch locale when validating those missing date-times the next valid time will be returned instead of generating an error
static Date	getFirstDayOfNextMonth(Date dt) Gets the first day of the next month for the date specified in parameter.
static Calendar	getIsoCalendarForYearAndWeek(int year, int weekOfYear) Returns ISO calendar with specified year and week.
static int	getMonth(Date date) Returns month for Date.
static long	getTime(Date from, TimeUnit unit) Extract the time fields from a date value and return as a value in the specified unit.
static int	getYear(Date date) Returns year for Date.
static Date	incrementDate(Date dt, int field, int amount) Returns date incremented for specified value.
static boolean	isFutureIndeterminate(Date date) Return T if the date is a indeterminate future date.
static boolean	isTestDateSet()
static boolean	isWeekend(Calendar cal)
static void	main(String[] args)
static Date	now()
static boolean	overlaps(Date s1, Date e1, Date s2, Date e2)
static void	setDate(Calendar cal, int year, int month, int day)
static Date	setDateOnly(Date finisheddate, Date dt) Updates the date part of a date only, leaving the time part unaltered.
static void	setSystemTestDate(Date now)
static void	setTestDate(Date now)
static void	setTime(Calendar cal, int h, int m, int s, int ms)
static Date	sqlToUtilDate(Date sqlDate) Converts java.sql.Date to java.util.Date.
static Date	tomorrow(Date dt) Calculates the date for 0:00 the day after (tomorrow).
static Date	truncateCeil(Date date) Truncate a date to be at 0:00 by ceiling the time.
static Date	truncateDate(Date dt)
static void	truncateDate(Date dest, Date dt)
static Date	truncateSeconds(Date dt)
static Date	yearStartDate(int year)

Methods inherited from class java.lang.Object

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

Field Detail

FUTURE

@Nonnull
public static final Date FUTURE

A fixed date way into the future.

CALENDAR_TIMES_COMPARATOR

public static final Comparator<Calendar> CALENDAR_TIMES_COMPARATOR

Compares calendar times (hours, minutes, seconds and milliseconds) and returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. They are compared by using compareTo() method. Second's calendar time is set to the copy of the first calendar to ensure that they can be different in time only.

Method Detail

getTime

public static long getTime(@Nonnull
                           Date from,
                           @Nonnull
                           TimeUnit unit)

Extract the time fields from a date value and return as a value in the specified unit. Rounding will be to floor.

Parameters:

from -

unit -

Returns:

truncateCeil

@Nonnull
public static Date truncateCeil(@Nonnull
                                         Date date)

Truncate a date to be at 0:00 by ceiling the time. If the date entered has a time > 0:00.0000 then the time is cleared and the day incremented by one.

Parameters:

date -

Returns:

isWeekend

public static boolean isWeekend(@Nonnull
                                Calendar cal)

dateFromDateTime

public static Date dateFromDateTime(Date coredate,
                                    String timestring)

Decraps the separate date / time found in the VP database into a normal date containing the time. This needs to be as speedy as possible.

Parameters:

coredate -

timestring -

Returns:

encodeTimeInMS

public static String encodeTimeInMS(long millis,
                                    int nfields,
                                    boolean shortest)

Quick conversion of time to a string for presentation pps.

Parameters:

millis - Time in millis.

nfields - The number of fields to show: 1 = hours only, 2= hh:mm, 3=h:mm:ss. Warning: the fields that are not shown do not "round up" the shown fields! So if you use nfields=1 for 18:45 the hour shown would be 18, not 19!

shortest - When set this truncates the time display when components are zero. So for 18:00:0) this would render '18'; for 18:21:00 this would render 18:21.

Returns:

decodeTime

public static long decodeTime(String timestring)

Decodes a time string, encoded as hh:mm:ss.mmmm where ss.mmmm are optional. If the field is invalid this returns -1, else it returns the #of ms representing the time.

Parameters:

time -

Returns:

extractTimeString

public static String extractTimeString(Date dt,
                                       int size)

Extracts the dumb time field from a date.

Parameters:

dt -

Returns:

truncateDate

public static Date truncateDate(Date dt)

truncateSeconds

public static Date truncateSeconds(Date dt)

incrementDate

public static Date incrementDate(Date dt,
                                 int field,
                                 int amount)

Returns date incremented for specified value.

Parameters:

dt -

field - see Calendar.add(int, int)

amount - see Calendar.add(int, int)

Returns:

In case of dt is null returns null

truncateDate

public static void truncateDate(Date dest,
                                Date dt)

tomorrow

public static Date tomorrow(Date dt)

Calculates the date for 0:00 the day after (tomorrow). Works like the EndOfDay but returns one minute later.

Parameters:

ts -

Returns:

dumbEndOfDayDate

public static Date dumbEndOfDayDate(Date dt)

INTERNAL DAO USE ONLY -- This returns a date/ which ends at 23:59 of the day passed. It is used within DAO's only to allow Hibernate to query split date/time fields.

Parameters:

dt -

Returns:

clearTime

public static void clearTime(Calendar cal)

Clears the entire time portion of a Calendar.

Parameters:

cal -

yearStartDate

public static Date yearStartDate(int year)

calculateDurationEndInSec

public static Date calculateDurationEndInSec(Date start,
                                             int durationInSeconds)

dateFor

public static Date dateFor(int year,
                           int month,
                           int day)

setDate

public static void setDate(Calendar cal,
                           int year,
                           int month,
                           int day)

dateFor

public static Date dateFor(int year,
                           int month,
                           int day,
                           int hour,
                           int minute,
                           int sec,
                           int mils)

setTime

public static void setTime(Calendar cal,
                           int h,
                           int m,
                           int s,
                           int ms)

addMinutes

public static Date addMinutes(Date in,
                              int minutes)

addDays

@Nonnull
public static Date addDays(@Nonnull
                                    Date in,
                                    int days)

addMonths

public static Date addMonths(Date in,
                             int months)

addYears

public static Date addYears(Date in,
                            int years)

between

public static boolean between(Date start,
                              Date end,
                              Date v)

overlaps

public static boolean overlaps(Date s1,
                               Date e1,
                               Date s2,
                               Date e2)

main

public static void main(String[] args)

setDateOnly

public static Date setDateOnly(Date finisheddate,
                               Date dt)

Updates the date part of a date only, leaving the time part unaltered.

Parameters:

finisheddate -

dt -

Returns:

getFirstDayOfNextMonth

public static Date getFirstDayOfNextMonth(Date dt)

Gets the first day of the next month for the date specified in parameter.

Parameters:

dt -

Returns:

deltaMonths

public static int deltaMonths(Date start,
                              Date end)

deltaInDays

public static int deltaInDays(Date start,
                              Date end)

Get the difference in number of days between the specified dates.

Parameters:

start -

end -

Returns:

getIsoCalendarForYearAndWeek

public static Calendar getIsoCalendarForYearAndWeek(int year,
                                                    int weekOfYear)

Returns ISO calendar with specified year and week.

Parameters:

year -

weekOfYear -

Returns:

convertToDate

@Nonnull
public static Date convertToDate(@Nonnull
                                          String input,
                                          @Nonnull
                                          String dateFormat,
                                          boolean lenient)
                                   throws ParseException

Parses input String to Date class, according to dateFormat argument.

Parameters:

input - - input string to be parsed

dateFormat - - to what format should the date be parsed

lenient - - specify whether or not date/time parsing is to be lenient

Returns:

Throws:

ParseException

convertToDate

@Nonnull
public static Date convertToDate(@Nonnull
                                          String input,
                                          @Nonnull
                                          String dateFormat)
                                   throws ParseException

Parses input String to Date class, according to dateFormat argument. Lenient is true.

Parameters:

input -

dateFormat -

Returns:

Throws:

ParseException

getYear

public static int getYear(@Nonnull
                          Date date)

Returns year for Date.

Parameters:

date -

Returns:

getMonth

public static int getMonth(@Nonnull
                           Date date)

Returns month for Date. January is 1, February 2, etc...

Parameters:

date -

Returns:

sqlToUtilDate

public static Date sqlToUtilDate(@Nullable
                                 Date sqlDate)

Converts java.sql.Date to java.util.Date. Returns null if sqlDate is null.

Parameters:

sqlDate -

Returns:

formatSafe

@Nonnull
public static String formatSafe(@Nullable
                                         Date date,
                                         @Nonnull
                                         DateFormat format)

Returns format for specified date and formatter. In case of null date returns empty string.

Parameters:

date -

format -

Returns:

now

@Nonnull
public static Date now()

setTestDate

public static void setTestDate(@Nullable
                               Date now)

isTestDateSet

public static boolean isTestDateSet()

setSystemTestDate

public static void setSystemTestDate(@Nullable
                                     Date now)

getCalendar

@Nonnull
public static Calendar getCalendar()

GregorianCalendarFixDutchTime fixes missing date-time in the GregorianCalendar for dutch locale when validating those missing date-times the next valid time will be returned instead of generating an error

Returns:

GregorianCalendarFixDutchTime

getCalendar

@Nonnull
public static Calendar getCalendar(@Nonnull
                                            Locale aLocale)

GregorianCalendarFixDutchTime fixes missing date-time in the GregorianCalendar for dutch locale when validating those missing date-times the next valid time will be returned instead of generating an error

Parameters:

aLocale -

Returns:

GregorianCalendarFixDutchTime

isFutureIndeterminate

public static boolean isFutureIndeterminate(@Nullable
                                            Date date)

Return T if the date is a indeterminate future date. This is usually something like 2999-31-12 or even further.

Parameters:

date -

Returns: