com.aspc.remote.util.misc

Class DateUtil

java.lang.Object

com.aspc.remote.util.misc.DateUtil

public final class DateUtil
extends java.lang.Object

DateUtil misc utilities for handling dates.

Since:

18 August 1998

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.TimeZone	GMT_ZONE the GMT ZONE.
static java.lang.String	RFC1123_PATTERN RFC1123 PATTERN.
static java.lang.String	TYPE_LAST_YEAR User date Last year
static java.lang.String	TYPE_NOW User date NOW
static java.lang.String	TYPE_TODAY User date TODAY
static java.lang.String	TYPE_TOMORROW User date TOMORROW
static java.lang.String	TYPE_YESTERDAY User date YESTERDAY

Method Summary

Modifier and Type	Method and Description
static java.util.Date	dateAdd(java.util.Date start, java.lang.String type, int value)
static long	dateDiff(java.util.Date start, java.util.Date end, java.lang.String type) get the date difference with the default time zone.
static long	dateDiff(java.util.Date start, java.util.Date end, java.lang.String type, java.util.TimeZone tzStart, java.util.TimeZone tzEnd) get the date difference with the given time zones and dates
static int	getCurrentYear(java.util.TimeZone timeZone) This function returns the current year
static int	getDayOfMonth(java.util.TimeZone timeZone, java.util.Date date, int givenDay, int occurence) This function returns the first given day of the month of the date passed
static java.lang.String	getDayOfWeek(java.util.TimeZone timeZone, java.util.Date date, boolean inLongFormat) getDayOfWeek returns the day of week
static int	getDayOfWeekInt(java.util.TimeZone timeZone, java.util.Date date) getDayOfWeek returns the day of week in integer
static int	getFirstWeekDayOfMonth(java.util.TimeZone timeZone, java.util.Date date) This function returns the first business/week day of the month of the date passed
static int	getLastWeekDayOfMonth(java.util.TimeZone timeZone, java.util.Date date) This function returns the last business/weekday day of the month of the date passed
static java.lang.String	getStdFormat(java.util.Date date, java.util.TimeZone timeZone)
static java.util.Date	getToday(java.util.TimeZone timeZone) Gets current date with no time
static java.util.GregorianCalendar	getTodayGC(java.util.TimeZone timeZone) Gets current date with no time
static java.util.Date	getTommorrow(java.util.TimeZone timeZone) This function returns the date for tomorrow
static int	getWeekDayOfMonth(java.util.TimeZone timeZone, java.util.Date date, int occurence) This function returns the WeekDay/business day of the month like., first, second, third ..etc based on occurrence.
static long	getWeekDaysBetween(java.util.TimeZone timeZone, java.util.Date start, java.util.Date end) This function returns the WeekDays between start date and end date,
static int	getWeekendDayOfMonth(java.util.TimeZone timeZone, java.util.Date date, int occurence) This function returns the Weekend day of the month like., first, second, third ..etc based on occurrence.
static java.util.Date	getYesterday(java.util.TimeZone timeZone) This function returns the date for yesterday
static boolean	isWeekDay(int day) This function checks if the day passed is a week day
static java.util.GregorianCalendar	makeGC(java.util.TimeZone timeZone, java.util.Date date) initializes a calendar with the passed in timezone ( GMT if null) and the date ( current time if null)
static int	monthsBetween(java.util.Date start, java.util.Date end) Different in months
static java.util.Date	parse(java.lang.String format, java.lang.String value)
static java.util.Date	parseUserDate(java.lang.String userDate, java.util.TimeZone timeZone, boolean allowFutureDates)
static java.lang.String	toJSON(java.util.Date date)
static java.util.Date	weekEnd(java.util.Date dt, java.util.TimeZone timeZone)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_NOW

public static final java.lang.String TYPE_NOW

User date NOW

See Also:

Constant Field Values

TYPE_TODAY

public static final java.lang.String TYPE_TODAY

User date TODAY

See Also:

Constant Field Values

TYPE_TOMORROW

public static final java.lang.String TYPE_TOMORROW

User date TOMORROW

See Also:

Constant Field Values

TYPE_YESTERDAY

public static final java.lang.String TYPE_YESTERDAY

User date YESTERDAY

See Also:

Constant Field Values

TYPE_LAST_YEAR

public static final java.lang.String TYPE_LAST_YEAR

User date Last year

See Also:

Constant Field Values

GMT_ZONE

public static final java.util.TimeZone GMT_ZONE

the GMT ZONE.

RFC1123_PATTERN

public static final java.lang.String RFC1123_PATTERN

RFC1123 PATTERN.

See Also:

Constant Field Values

Method Detail

dateDiff

@CheckReturnValue
public static long dateDiff(java.util.Date start,
                                              java.util.Date end,
                                              java.lang.String type)

get the date difference with the default time zone. Use the dateDiff( Date start, Date end, String type, TimeZone tzStart, TimeZone tzEnd) method as possible as you could.

Parameters:

start - start date

end - end date

type - return value type

Returns:

long value of the given type

dateDiff

@CheckReturnValue
public static long dateDiff(java.util.Date start,
                                              java.util.Date end,
                                              java.lang.String type,
                                              java.util.TimeZone tzStart,
                                              java.util.TimeZone tzEnd)

get the date difference with the given time zones and dates

Parameters:

start - start date

end - end date

type - return value type

tzStart - time zone of the start date

tzEnd - time zone of the end date

Returns:

long value of the given type

toJSON

@CheckReturnValue
 @Nonnull
public static java.lang.String toJSON(@Nonnull
                                                                  java.util.Date date)

dateAdd

@CheckReturnValue
 @Nonnull
public static java.util.Date dateAdd(java.util.Date start,
                                                                 java.lang.String type,
                                                                 int value)

Parameters:

start - start date

type - type of value

value - value to be added

Returns:

added date

weekEnd

@CheckReturnValue
 @Nonnull
public static java.util.Date weekEnd(@Nonnull
                                                                 java.util.Date dt,
                                                                 @Nullable
                                                                 java.util.TimeZone timeZone)

Parameters:

dt -

timeZone - the timezone.

Returns:

the value

isWeekDay

@CheckReturnValue
public static boolean isWeekDay(int day)

This function checks if the day passed is a week day

Parameters:

day - WeekDay

Returns:

boolean True if it is a week day else false

getFirstWeekDayOfMonth

@CheckReturnValue
public static int getFirstWeekDayOfMonth(java.util.TimeZone timeZone,
                                                           java.util.Date date)

This function returns the first business/week day of the month of the date passed

Parameters:

timeZone - the user's timezone

date - the date to check

Returns:

int the first week/business day of the month

getDayOfMonth

@CheckReturnValue
public static int getDayOfMonth(java.util.TimeZone timeZone,
                                                  java.util.Date date,
                                                  int givenDay,
                                                  int occurence)
                                           throws java.lang.Exception

This function returns the first given day of the month of the date passed

Parameters:

timeZone - the user's time zone

date - the date to check

occurence - Example, 2 represents the 2nd occurrence of the day from 1 to 31.

givenDay - the day to find out in the month

Returns:

int the first given day of the month of the date passed

Throws:

java.lang.Exception - A serious problem occurred

getWeekendDayOfMonth

@CheckReturnValue
public static int getWeekendDayOfMonth(java.util.TimeZone timeZone,
                                                         java.util.Date date,
                                                         int occurence)

This function returns the Weekend day of the month like., first, second, third ..etc based on occurrence. if occurrence is 2 then 2nd Weekend day of month. if occurrence is -2 then last second weekend day of the month

Parameters:

timeZone - the user's time zone

date - the date to check

occurence - can have values like -4,-3, -2, -1, 1, 2, 3,4

Returns:

int the weekend day of the month

getWeekDayOfMonth

@CheckReturnValue
 @Nonnull
public static int getWeekDayOfMonth(java.util.TimeZone timeZone,
                                                                java.util.Date date,
                                                                int occurence)
                                                         throws java.lang.Exception

This function returns the WeekDay/business day of the month like., first, second, third ..etc based on occurrence. if occurrence is 2 then 2nd business day of month. if occurrence is -2 then last second business day of the month

Parameters:

timeZone - the user's time zone

date - the date to check

occurence - can have values like -20... -3, -2, -1, 1, 2, 3 ...20

Returns:

int the first weekday/business day of the month

Throws:

java.lang.Exception - A serious problem occurs

getWeekDaysBetween

@CheckReturnValue
public static long getWeekDaysBetween(java.util.TimeZone timeZone,
                                                        java.util.Date start,
                                                        java.util.Date end)
                                                 throws java.lang.Exception

This function returns the WeekDays between start date and end date,

Parameters:

timeZone - the user's time zone

start - start date

end - end date

Returns:

weekdays

Throws:

java.lang.Exception - A serious problem occurs

getLastWeekDayOfMonth

@CheckReturnValue
public static int getLastWeekDayOfMonth(java.util.TimeZone timeZone,
                                                          java.util.Date date)

This function returns the last business/weekday day of the month of the date passed

Parameters:

timeZone - the user's timezone

date - the date to check

Returns:

int the last weekday/business day of the month

getDayOfWeekInt

@CheckReturnValue
public static int getDayOfWeekInt(java.util.TimeZone timeZone,
                                                    java.util.Date date)

getDayOfWeek returns the day of week in integer

Parameters:

timeZone - The time zone

date - The date to be checked

Returns:

day of week

getDayOfWeek

@CheckReturnValue
 @Nonnull
public static java.lang.String getDayOfWeek(java.util.TimeZone timeZone,
                                                                        java.util.Date date,
                                                                        boolean inLongFormat)

getDayOfWeek returns the day of week

Parameters:

timeZone - The time zone

date - The date to be checked

inLongFormat - The format of the weekday format i.e. [true: Sunday] | [false: Sun]

Returns:

day of week

makeGC

@CheckReturnValue
 @Nonnull
public static java.util.GregorianCalendar makeGC(@Nullable
                                                                             java.util.TimeZone timeZone,
                                                                             @Nullable
                                                                             java.util.Date date)

initializes a calendar with the passed in timezone ( GMT if null) and the date ( current time if null)

Parameters:

timeZone - the user's timezone

date - the date to set the calendar to.

Returns:

the initialized calendar.

getTodayGC

@CheckReturnValue
 @Nonnull
public static java.util.GregorianCalendar getTodayGC(java.util.TimeZone timeZone)

Gets current date with no time

Parameters:

timeZone - the user's timezone

Returns:

Date

getToday

@CheckReturnValue
 @Nonnull
public static java.util.Date getToday(java.util.TimeZone timeZone)

Gets current date with no time

Parameters:

timeZone - the user's timezone

Returns:

Date

getTommorrow

@CheckReturnValue
 @Nonnull
public static java.util.Date getTommorrow(java.util.TimeZone timeZone)

This function returns the date for tomorrow

Parameters:

timeZone - the user's timezone

Returns:

Date the result date

getYesterday

@CheckReturnValue
 @Nonnull
public static java.util.Date getYesterday(java.util.TimeZone timeZone)

This function returns the date for yesterday

Parameters:

timeZone - the user's timezone

Returns:

Date the result date

getCurrentYear

@CheckReturnValue
public static int getCurrentYear(java.util.TimeZone timeZone)

This function returns the current year

Parameters:

timeZone - the user's timezone

Returns:

the year

parseUserDate

@CheckReturnValue
 @Nonnull
public static java.util.Date parseUserDate(java.lang.String userDate,
                                                                       java.util.TimeZone timeZone,
                                                                       boolean allowFutureDates)
                                                                throws InvalidDataException

Parameters:

userDate -

timeZone - the user's timezone

allowFutureDates -

Returns:

the value

Throws:

InvalidDataException

getStdFormat

@CheckReturnValue
 @Nonnull
public static java.lang.String getStdFormat(@Nonnull
                                                                        java.util.Date date,
                                                                        @Nullable
                                                                        java.util.TimeZone timeZone)

Parameters:

date -

timeZone - the user's timezone

Returns:

the value

parse

@CheckReturnValue
 @Nonnull
public static java.util.Date parse(@Nonnull
                                                               java.lang.String format,
                                                               @Nonnull
                                                               java.lang.String value)
                                                        throws java.lang.Exception

Parameters:

format -

value - the value

Returns:

the value

Throws:

java.lang.Exception - a serious problem

monthsBetween

@CheckReturnValue
public static int monthsBetween(@Nonnull
                                                  java.util.Date start,
                                                  @Nonnull
                                                  java.util.Date end)

Different in months

Parameters:

start - start date

end - end date

Returns:

Different in months