Package com.storedobject.common

Class DateUtility

java.lang.Object

com.storedobject.common.DateUtility

Direct Known Subclasses:

DateUtility

public class DateUtility
extends Object

Date utility functions. (Old Date and its cousin Date are still used in JDBC).

Author:

Syam

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DateUtility()	A utility class for performing date-related operations.

Method Summary

Modifier and Type	Method	Description
static <D extends Date> D	addDay(D date, int day)	Adds a particular number of days to a specified date
static <D extends Date> D	addMonth(D date, int month)	Adds a particular number of months to a specified date
static <D extends Date> D	addYear(D date, int year)	Adds a particular number of years to a specified date
static <D extends Date> D	clone(D date)	Duplicates the date object passed
static <D extends Date> int	compareTo(D one, D two)	Compare two dates
static Date	create()	Create and return the Date instance for the current date
static Date	create(int dateValue)	Get a date corresponding to a particular date value in a year
static Date	create(int year, int month, int day)	Create a Date instance when day, month, year are specified.
static <D extends Date> Date	create(D date)	Get a java.sql.Date corresponding to a given java.util.Date
static Date	create(String text)	Get a date by passing date string separated by spaces, commas, hyphens, or slashes.
static Date	create(LocalDate date)	Get the java.sql.Date from a java.time.LocalDate
static Date	create(Calendar c)	Create a Date instance by passing a Calendar instance
static Time	createTime(LocalDateTime date)	Get time by passing LocalDateTime
static Time	createTime(Calendar calendar)	Get the Time value corresponding to a Calendar instance
static Time	createTime(Date date)	Get the Time value corresponding to a java.util.Date instance
static Timestamp	createTimestamp(long time)	Creates a Timestamp instance from the specified epoch time.
static Timestamp	createTimestamp(LocalDateTime date)	Get TimeStamp by passing LocalDateTime
static Timestamp	createTimestamp(Date date)	Creates a Timestamp instance from the specified Date.
static DateFormat	dateFormat()	Returns a clone of the Java DateFormat instance.
static DateFormat	dateTimeFormat()	Returns a clone of the default date and time format.
static <D extends Date> String	difference(D from, int days)	Get the difference between two dates as a string representation in the form "3Y 2M 4D" (meaning 3 years, 2 months, 4 days).
static <D extends Date> String	difference(D one, D two)	Get the difference between two dates as a string representation in the form "3Y 2M 4D" (meaning 3 years, 2 months, 4 days).
static Date	endOfMonth()	Get end date of current month.
static Date	endOfMonth(int monthOffset)	Get an end date of a month.
static <D extends Date> D	endOfMonth(int monthOffset, D date)	Get an end date of a month.
static <D extends Date> D	endOfMonth(D date)	Get end date of month for a give date
static Timestamp	endOfToday()	Gets the timestamp for the current date with the time set to end time of the day
static Date	endOfYear()	Get end date of current year
static <D extends Date> D	endOfYear(D date)	Get end date of year for a give date
static Timestamp	endOfYesterday()	Gets the timestamp for the previous date with the time set to end time of the day
static Timestamp	endTime(Date date)	Gets the timestamp for the date provided and the time set to end time of that day
static <D extends Date> boolean	equals(D one, D two)	Check whether two dates are the same
static <D extends Date> String	format(D date)	Formats the given date
static <D extends Date> String	formatDate(D date)	Formats a given date in SQL date format
static String	formatHHMM(long time)	Formats the given time in milliseconds into a string in HH:mm format.
static <D extends Date> String	formatHHMM(D date)	Formats the given date into a string representing the time in HH:mm format.
static <D extends Date> String	formatLongDate(D date)	Formats a given date and time
static <D extends Date> String	formatMonth(D date)	Formats the given date into a string representing the month.
static <D extends Date> String	formatShortDate(D date)	Formats a given date in MMM dd, yy format
static <D extends Date> String	formatTime(D date)	Formats the given date object into a string representation according to the pre-defined time format.
static <D extends Date> String	formatTinyDate(D date)	Formats a given date in MM yy format
static <D extends Date> String	formatWithTime(D date)	Formats the given date
static <D extends Date> String	formatWithTimeHHMM(D date)	Formats the given date
static <D extends Date> D	fromGMT(D date, String toTimeZone)	Converts the given date from GMT to the specified time zone.
static <D extends Date> D	fromGMT(D date, ZoneId toZoneId)	Converts the given date from GMT (Greenwich Mean Time) to a specified time zone.
static <D extends Date> D	fromGMT(D dateGMT, ZoneOffset toZoneOffset)	Translates a given date from GMT to a specified time zone.
static <D extends Date> D	fromGMT(D date, TimeZone toTimeZone)	Converts a given date from GMT (Greenwich Mean Time) to the specified time zone.
static <D extends Date> int	get(D date, int field)	Returns the value of the specified calendar field extracted from the given date.
static int	getDay()	Retrieves the current day of the month based on the system's current date.
static <D extends Date> int	getDay(D date)	Retrieves the day of the month from the specified date.
static <D extends Date> int	getDayOfYear(D date)	Get the day of the year.
static <D extends Date> int	getHourOfYear(D date)	Get the hour of the year.
static int	getMonth()	Retrieves the current month as an integer value.
static <D extends Date> int	getMonth(D date)	Returns the month of the year for the given date.
static int	getMonth(String monthName)	Retrieves the numeric value of a month based on its name.
static String	getMonthName(int m)	Returns the name of the month corresponding to the given month number.
static <D extends Date> String	getMonthName(D date)	Retrieves the name of the month for the specified date.
static String[]	getMonthNames()	Returns an array of month names.
static int	getMonthZeroBased()	Retrieves the current month as a zero-based index (0 for January, 1 for February, etc.).
static <D extends Date> int	getMonthZeroBased(D date)	Retrieves the month from the given date as a zero-based value.
static <D extends Date> int	getPeriodInDays(D one, D two)	Get the difference in days between two dates
static <D extends Date> int	getPeriodInDays(D one, D two, boolean considerTime)	Get the difference in days between two dates by considering the time as well
static <D extends Date> int	getPeriodInMonths(D one, D two)	Get the difference in months between two dates
static String[]	getWeekNames()	Retrieves the names of the days in a week.
static <D extends Date> int	getWeekOfYear(D date)	Get the week of the year.
static int	getYear()	Retrieves the current year based on the system's local date.
static <D extends Date> int	getYear(D date)	Gets the year value for a particular date
static boolean	isLeapYear(int year)	Checks if a particular year specified is leap year
static <D extends Date> boolean	isLeapYear(D date)	Checks if a particular year is a leap year by taking in a date
static <D extends Date> boolean	isSameDate(D one, D two)	Validates and returns true if two dates passed to the method are the same
static <D extends Date> LocalDate	local(D date)	Get java.time.LocalDate by passing a Date
static <D extends Date> LocalDateTime	localTime(D date)	Get java.time.LocalDateTime by passing a Date
static Date	maximumDate()	Returns the maximum possible date value.
static Timestamp	now()	Get the current timestamp
static <D extends Date> D	setDay(D date, int day)	Sets the day of the given date to the specified day value.
static <D extends Date> D	setMonth(D date, int month)	Sets the month of this date to the specified value.
static <D extends Date> D	setYear(D date, int year)	Sets the specified year for the given date object and returns the updated date.
static Date	startOfMonth()	Get the start date of the current month
static Date	startOfMonth(int monthOffset)	Get a start date of a month.
static <D extends Date> D	startOfMonth(int monthOffset, D date)	Get a starting date of a month.
static <D extends Date> D	startOfMonth(D date)	Get start date of month for a give date
static Timestamp	startOfToday()	Gets the timestamp for the current date with the time set to start time of the day
static Timestamp	startOfTomorrow()	Gets the timestamp for the next date with the time set to start time of the day
static Date	startOfYear()	Get the start date of the current year
static <D extends Date> D	startOfYear(D date)	Get the start date of year for a given date
static Timestamp	startTime(Date date)	Gets a timestamp for the date provided and the time set to start time of that day
static Time	time()	Gets the current date and time value as a Time.
static DateFormat	timeFormat()	Retrieves a clone of the time format used by the application.
static DateFormat	timeFormat24()	Returns a cloned instance of the default 24-hour time format.
static Date	today()	Get the current date
static <D extends Date> D	toGMT(D date, String fromTimeZone)	Converts a given date to Greenwich Meantime (GMT) based on the provided time zone.
static <D extends Date> D	toGMT(D date, ZoneId fromZoneId)	Converts a given date to the GMT timezone.
static <D extends Date> D	toGMT(D date, ZoneOffset fromZoneOffset)	Converts the given date to GMT (Greenwich Mean Time) by subtracting the offset caused by the provided ZoneOffset.
static <D extends Date> D	toGMT(D date, TimeZone fromTimeZone)	Converts the given date to GMT (Greenwich Mean Time) by converting its time zone to GMT.
static Date	tomorrow()	Get one day after the current date
static Time	trimHours(Time time)	Trims the hours portion of the given time value.
static Timestamp	trimHours(Timestamp time)	Trims the hours, minutes, seconds, and milliseconds from the given Timestamp, effectively resetting the time to midnight of the same date.
static Time	trimMillis(Time time)	Trims the millisecond portion of the given time value.
static Timestamp	trimMillis(Timestamp time)	Trims the milliseconds portion of the provided Timestamp.
static Time	trimMinutes(Time time)	Trims the minutes portion of the given time value.
static Timestamp	trimMinutes(Timestamp time)	Adjusts the given Timestamp by removing the minutes and seconds components, effectively rounding down to the start of the nearest hour.
static Time	trimSeconds(Time time)	Trims the seconds portion of the given time value.
static Timestamp	trimSeconds(Timestamp time)	Trims the seconds and milliseconds from the given Timestamp, rounding down to the nearest minute.
static Date	yesterday()	Get one day prior to the current date

Methods inherited from class java.lang.Object

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

Constructor Details

DateUtility

protected DateUtility()

A utility class for performing date-related operations. This class is not intended to be instantiated directly. The constructor is protected to prevent unauthorized instantiation from outside the class while allowing inheritance if necessary.

Method Details

today

public static Date today()

Get the current date

Returns:

Current Date

tomorrow

public static Date tomorrow()

Get one day after the current date

Returns:

One day after the current date

yesterday

public static Date yesterday()

Get one day prior to the current date

Returns:

One day prior to the current date

startOfYear

public static Date startOfYear()

Get the start date of the current year

Returns:

Start date of the current year

startOfYear

public static <D extends Date> D startOfYear(D date)

Get the start date of year for a given date

Type Parameters:

D - Date-type

Parameters:

date - Date for which the start of the year is to be returned

Returns:

Start date of year for a give date

endOfYear

public static Date endOfYear()

Get end date of current year

Returns:

End date of the current year

endOfYear

public static <D extends Date> D endOfYear(D date)

Get end date of year for a give date

Type Parameters:

D - Date-type

Parameters:

date - Date for which the end of the year is to be returned

Returns:

End date of year for a give date

startOfMonth

public static Date startOfMonth()

Get the start date of the current month

Returns:

Start date of the current month

startOfMonth

public static <D extends Date> D startOfMonth(D date)

Get start date of month for a give date

Type Parameters:

D - Date-type

Parameters:

date - Date for which the start of the month is to be returned

Returns:

Start date of month for a give date

startOfMonth

public static Date startOfMonth(int monthOffset)

Get a start date of a month. Month is calculated by adding an offset to the current month

Parameters:

monthOffset - An integer offset value that has to be added to the current month value

Returns:

Start date of month

startOfMonth

public static <D extends Date> D startOfMonth(int monthOffset,
 D date)

Get a starting date of a month.

Type Parameters:

D - Date-type

Parameters:

monthOffset - An integer offset value that needs to be added to the month corresponding to a given date.

date - Date for which the start of the month is to be returned.

Returns:

Start date of month

endOfMonth

public static Date endOfMonth()

Get end date of current month.

Returns:

End date of the current month

endOfMonth

public static <D extends Date> D endOfMonth(D date)

Get end date of month for a give date

Type Parameters:

D - Date-type

Parameters:

date - Date for which the end of the month is to be returned

Returns:

Start date of month for a give date

endOfMonth

public static Date endOfMonth(int monthOffset)

Get an end date of a month. Month is calculated by adding an offset to the current month

Parameters:

monthOffset - An integer offset value that has to be added to the current month value

Returns:

Start date of month

endOfMonth

public static <D extends Date> D endOfMonth(int monthOffset,
 D date)

Get an end date of a month. Month is calculated by adding an offset to the month corresponding to a given date

Type Parameters:

D - Date-type

Parameters:

monthOffset - An integer offset value that has to be added to the month corresponding to a given date

date - Date for which the end of the month is to be returned.

Returns:

End date of month

create

public static Date create(Calendar c)

Create a Date instance by passing a Calendar instance

Parameters:

c - Calendar instance

Returns:

Date corresponding to the calendar instance

create

public static Date create()

Create and return the Date instance for the current date

Returns:

Current date

create

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

Create a Date instance when day, month, year are specified.

Parameters:

year - Year.

month - Month (1-based, not 0-based).

day - Day.

Returns:

Date for the specified day, month and year

create

public static <D extends Date> Date create(D date)

Get a java.sql.Date corresponding to a given java.util.Date

Type Parameters:

D - the type of the date parameter, which must extend java.util.Date

Parameters:

date - Date of type java.util.Date

Returns:

date

create

public static Date create(int dateValue)

Get a date corresponding to a particular date value in a year

Parameters:

dateValue - an integer representing the date

Returns:

Date corresponding to the given date value in integer

create

public static Date create(String text)

Get a date by passing date string separated by spaces, commas, hyphens, or slashes. It could contain just digits (with or without separators) or strings such as "Aug 15, 1947", "23 Jan 1998", etc.

Parameters:

text - Date in text format

Returns:

Date corresponding to the given date text

create

public static Date create(LocalDate date)

Get the java.sql.Date from a java.time.LocalDate

Parameters:

date - LocalDate that has to be converted to java.sql.Date

Returns:

date

createTime

public static Time createTime(LocalDateTime date)

Get time by passing LocalDateTime

Parameters:

date - LocalDateTime

Returns:

Time

createTimestamp

public static Timestamp createTimestamp(LocalDateTime date)

Get TimeStamp by passing LocalDateTime

Parameters:

date - LocalDateTime

Returns:

Timestamp

local

public static <D extends Date> LocalDate local(D date)

Get java.time.LocalDate by passing a Date

Type Parameters:

D - Date-type

Parameters:

date - Date

Returns:

date LocalDate

localTime

public static <D extends Date> LocalDateTime localTime(D date)

Get java.time.LocalDateTime by passing a Date

Type Parameters:

D - Date-type

Parameters:

date - Date

Returns:

date Local date-time

createTime

public static Time createTime(Calendar calendar)

Get the Time value corresponding to a Calendar instance

Parameters:

calendar - Calendar

Returns:

Time instance

createTime

public static Time createTime(Date date)

Get the Time value corresponding to a java.util.Date instance

Parameters:

date - Date

Returns:

time

createTimestamp

public static Timestamp createTimestamp(long time)

Creates a Timestamp instance from the specified epoch time.

Parameters:

time - Epoch time in milliseconds.

Returns:

Timestamp corresponding to the given epoch time.

createTimestamp

public static Timestamp createTimestamp(Date date)

Creates a Timestamp instance from the specified Date.

Parameters:

date - Date to convert.

Returns:

Timestamp corresponding to the given date.

time

public static Time time()

Gets the current date and time value as a Time.

Returns:

Current time value.

trimMillis

public static Time trimMillis(Time time)

Trims the millisecond portion of the given time value.

Parameters:

time - Time value to trim.

Returns:

Time value with trimmed milliseconds.

trimSeconds

public static Time trimSeconds(Time time)

Trims the seconds portion of the given time value.

Parameters:

time - Time value to trim.

Returns:

Time value with trimmed seconds.

trimMinutes

public static Time trimMinutes(Time time)

Trims the minutes portion of the given time value.

Parameters:

time - Time value to trim.

Returns:

Time value with trimmed minutes.

trimHours

public static Time trimHours(Time time)

Trims the hours portion of the given time value.

Parameters:

time - Time value to trim.

Returns:

Time value with trimmed hours.

now

public static Timestamp now()

Get the current timestamp

Returns:

The current (UTC) Date and time

startTime

public static Timestamp startTime(Date date)

Gets a timestamp for the date provided and the time set to start time of that day

Parameters:

date - Date

Returns:

timestamp corresponding to the date passed with time set to start time of that day

endTime

public static Timestamp endTime(Date date)

Gets the timestamp for the date provided and the time set to end time of that day

Parameters:

date - Date

Returns:

timestamp corresponding to the date passed with time set to end time of that day

endOfToday

public static Timestamp endOfToday()

Gets the timestamp for the current date with the time set to end time of the day

Returns:

timestamp

endOfYesterday

public static Timestamp endOfYesterday()

Gets the timestamp for the previous date with the time set to end time of the day

Returns:

timestamp

startOfToday

public static Timestamp startOfToday()

Gets the timestamp for the current date with the time set to start time of the day

Returns:

timestamp

startOfTomorrow

public static Timestamp startOfTomorrow()

Gets the timestamp for the next date with the time set to start time of the day

Returns:

Timestamp

trimMillis

public static Timestamp trimMillis(Timestamp time)

Trims the milliseconds portion of the provided Timestamp.

Parameters:

time - the Timestamp object to be trimmed; must not be null

Returns:

a new Timestamp object with the milliseconds trimmed

trimSeconds

public static Timestamp trimSeconds(Timestamp time)

Trims the seconds and milliseconds from the given Timestamp, rounding down to the nearest minute.

Parameters:

time - the Timestamp to be trimmed; must not be null

Returns:

a new Timestamp representing the time rounded down to the nearest minute

trimMinutes

public static Timestamp trimMinutes(Timestamp time)

Adjusts the given Timestamp by removing the minutes and seconds components, effectively rounding down to the start of the nearest hour.

Parameters:

time - the Timestamp object to be trimmed; must not be null.

Returns:

a new Timestamp object with minutes and seconds set to zero, or null if the input is null.

trimHours

public static Timestamp trimHours(Timestamp time)

Trims the hours, minutes, seconds, and milliseconds from the given Timestamp, effectively resetting the time to midnight of the same date.

Parameters:

time - the Timestamp to be trimmed; must not be null

Returns:

a new Timestamp set to midnight of the same date as the input

formatMonth

public static <D extends Date> String formatMonth(D date)

Formats the given date into a string representing the month.

Type Parameters:

D - the type of the date parameter, which must extend java.util.Date

Parameters:

date - the date to be formatted; must not be null

Returns:

a string representation of the month extracted from the provided date

formatDate

public static <D extends Date> String formatDate(D date)

Formats a given date in SQL date format

Type Parameters:

D - Date-type

Parameters:

date - Date

Returns:

formatted date

formatLongDate

public static <D extends Date> String formatLongDate(D date)

Formats a given date and time

Type Parameters:

D - Date-type

Parameters:

date - Date

Returns:

formatted date and time

formatShortDate

public static <D extends Date> String formatShortDate(D date)

Formats a given date in MMM dd, yy format

Type Parameters:

D - Date-type

Parameters:

date - Date

Returns:

formatted date

formatTinyDate

public static <D extends Date> String formatTinyDate(D date)

Formats a given date in MM yy format

Type Parameters:

D - Date-type

Parameters:

date - Date

Returns:

formatted date

format

public static <D extends Date> String format(D date)

Formats the given date

Type Parameters:

D - Date-type

Parameters:

date - Date

Returns:

formatted date

formatWithTime

public static <D extends Date> String formatWithTime(D date)

Formats the given date

Type Parameters:

D - Date-type

Parameters:

date - Date

Returns:

formatted date in MM dd yyyy HH:MM:SS

formatWithTimeHHMM

public static <D extends Date> String formatWithTimeHHMM(D date)

Formats the given date

Type Parameters:

D - Date-type

Parameters:

date - Date

Returns:

formatted date in MM dd, yyyy HH:MM:SS AM/PM

formatTime

public static <D extends Date> String formatTime(D date)

Formats the given date object into a string representation according to the pre-defined time format.

Type Parameters:

D - the type of the date parameter, which must extend java.util.Date

Parameters:

date - the date object to be formatted; must be a subclass of java.util.Date

Returns:

a string representation of the formatted time

formatHHMM

public static <D extends Date> String formatHHMM(D date)

Formats the given date into a string representing the time in HH:mm format.

Type Parameters:

D - the type of the date parameter, which must extend java.util.Date

Parameters:

date - the date object to format, must not be null

Returns:

a string representing the time in HH:mm format

formatHHMM

public static String formatHHMM(long time)

Formats the given time in milliseconds into a string in HH:mm format.

Parameters:

time - the time in milliseconds to be formatted

Returns:

a string representation of the given time formatted as HH:mm

equals

public static <D extends Date> boolean equals(D one,
 D two)

Check whether two dates are the same

Type Parameters:

D - Date-type

Parameters:

one - first date to compare

two - second date to compare

Returns:

a boolean true if one and two are the same, otherwise false

compareTo

public static <D extends Date> int compareTo(D one,
 D two)

Compare two dates

Type Parameters:

D - Date-type

Parameters:

one - Date to compare

two - Date to compare

Returns:

A negative integer, zero, or a positive integer as 'one' is less than, equal to, or greater than 'two'.

getMonth

public static int getMonth(String monthName)

Retrieves the numeric value of a month based on its name.

Parameters:

monthName - the name of the month to be converted to its numeric representation

Returns:

the numeric value of the month (1 for January, 2 for February, etc.), or 0 if the month name is not recognized

getMonthName

public static String getMonthName(int m)

Returns the name of the month corresponding to the given month number.

Parameters:

m - the month number (1 for January, 2 for February, ..., 12 for December)

Returns:

the name of the month, or null if the input month number is out of range

getMonthName

public static <D extends Date> String getMonthName(D date)

Retrieves the name of the month for the specified date.

Type Parameters:

D - The type of the Date object, which must extend Date.

Parameters:

date - The date object from which the month name will be derived. Must not be null.

Returns:

The full name of the month corresponding to the provided date.

getYear

public static int getYear()

Retrieves the current year based on the system's local date.

Returns:

the current year as an integer

getYear

public static <D extends Date> int getYear(D date)

Gets the year value for a particular date

Type Parameters:

D - Date-type

Parameters:

date - Date

Returns:

year corresponding to the date passed

setYear

public static <D extends Date> D setYear(D date,
 int year)

Sets the specified year for the given date object and returns the updated date.

Type Parameters:

D - the type of the date object, which must extend Date

Parameters:

date - the date object to modify

year - the year to set in the date object

Returns:

the updated date object with the specified year set

getWeekOfYear

public static <D extends Date> int getWeekOfYear(D date)

Get the week of the year.

Type Parameters:

D - Date type.

Parameters:

date - Date

Returns:

Week number.

getDayOfYear

public static <D extends Date> int getDayOfYear(D date)

Get the day of the year.

Type Parameters:

D - Date type.

Parameters:

date - Date

Returns:

Day of the year.

getHourOfYear

public static <D extends Date> int getHourOfYear(D date)

Get the hour of the year.

Type Parameters:

D - Date type.

Parameters:

date - Date

Returns:

Hour of the year.

getMonth

public static int getMonth()

Retrieves the current month as an integer value.

Returns:

the current month, where January is 1 and December is 12

getMonth

public static <D extends Date> int getMonth(D date)

Returns the month of the year for the given date.

Type Parameters:

D - The type of the date parameter, which must extend java.util.Date.

Parameters:

date - The date object from which the month is to be extracted.

Returns:

The month of the year as an integer (1 for January, 2 for February, ..., 12 for December).

getMonthZeroBased

public static int getMonthZeroBased()

Retrieves the current month as a zero-based index (0 for January, 1 for February, etc.).

Returns:

the zero-based index of the current month

getMonthZeroBased

public static <D extends Date> int getMonthZeroBased(D date)

Retrieves the month from the given date as a zero-based value.

Type Parameters:

D - the type of the date parameter, which must extend java.util.Date

Parameters:

date - the date from which the month is to be extracted; must not be null

Returns:

the zero-based month (0 for January, 1 for February, ..., 11 for December)

setMonth

public static <D extends Date> D setMonth(D date,
 int month)

Sets the month of this date to the specified value.

Type Parameters:

D - Date-type

Parameters:

date - The original date

month - the month value that has to be set

Returns:

Date after setting the month value

getDay

public static int getDay()

Retrieves the current day of the month based on the system's current date.

Returns:

the day of the month as an integer

getDay

public static <D extends Date> int getDay(D date)

Retrieves the day of the month from the specified date.

Type Parameters:

D - the type of the date parameter, which must extend java.util.Date

Parameters:

date - the date object from which the day of the month is to be extracted; must not be null

Returns:

the day of the month as an integer

setDay

public static <D extends Date> D setDay(D date,
 int day)

Sets the day of the given date to the specified day value.

Type Parameters:

D - the type of the date object, which must extend java.util.Date

Parameters:

date - the date object whose day is to be set

day - the day value to set in the date object

Returns:

the updated date object with the new day value

addYear

public static <D extends Date> D addYear(D date,
 int year)

Adds a particular number of years to a specified date

Type Parameters:

D - Date-type

Parameters:

date - The date to which the years are added

year - The number of years to add to the date passed

Returns:

The date after adding the year offset

addMonth

public static <D extends Date> D addMonth(D date,
 int month)

Adds a particular number of months to a specified date

Type Parameters:

D - Date-type

Parameters:

date - The date to which the months are added

month - The number of months to add to the date passed

Returns:

The date after adding the month offset

addDay

public static <D extends Date> D addDay(D date,
 int day)

Adds a particular number of days to a specified date

Type Parameters:

D - Date-type

Parameters:

date - The date to which the days are added

day - The number of days to add to the date passed

Returns:

The date after adding the days offset

clone

public static <D extends Date> D clone(D date)

Duplicates the date object passed

Type Parameters:

D - Date-type

Parameters:

date - Date

Returns:

A duplicate of the date passed

isLeapYear

public static boolean isLeapYear(int year)

Checks if a particular year specified is leap year

Parameters:

year - Year

Returns:

true if the year passed to the method is leap year

isLeapYear

public static <D extends Date> boolean isLeapYear(D date)

Checks if a particular year is a leap year by taking in a date

Type Parameters:

D - Date-type

Parameters:

date - Date

Returns:

true if the year in the date passed to the method is leap year

getPeriodInDays

public static <D extends Date> int getPeriodInDays(D one,
 D two)

Get the difference in days between two dates

Type Parameters:

D - Date-type

Parameters:

one - Date that has to be subtracted from the greater date

two - The greater date from which the other date is subtracted

Returns:

The difference between date two and date one in days

getPeriodInDays

public static <D extends Date> int getPeriodInDays(D one,
 D two,
 boolean considerTime)

Get the difference in days between two dates by considering the time as well

Type Parameters:

D - Date-type

Parameters:

one - Date that has to be subtracted from the greater date

two - The greater date from which the other date is subtracted

considerTime - Whether to consider the time component in the calculation

Returns:

The difference between date two and date one in days

getPeriodInMonths

public static <D extends Date> int getPeriodInMonths(D one,
 D two)

Get the difference in months between two dates

Type Parameters:

D - Date-type

Parameters:

one - Date that has to be subtracted from the greater date

two - The greater date from which the other date is subtracted

Returns:

The difference between date two and date one in months

get

public static <D extends Date> int get(D date,
 int field)

Returns the value of the specified calendar field extracted from the given date.

Type Parameters:

D - the type of the date, which must extend Date

Parameters:

date - the date object from which the field value should be extracted

field - the calendar field to retrieve (e.g., Calendar.YEAR, Calendar.MONTH, etc.)

Returns:

the value of the specified calendar field for the given date

Throws:

NullPointerException - if the date is null

IllegalArgumentException - if the specified field is not a valid calendar field

isSameDate

public static <D extends Date> boolean isSameDate(D one,
 D two)

Validates and returns true if two dates passed to the method are the same

Type Parameters:

D - Date-type

Parameters:

one - First date

two - Second date

Returns:

True if two dates passed to the method are the same

difference

public static <D extends Date> String difference(D one,
 D two)

Get the difference between two dates as a string representation in the form "3Y 2M 4D" (meaning 3 years, 2 months, 4 days). The respective parts may be absent for zero values unless the result is just "0D".

Type Parameters:

D - Date-type

Parameters:

one - First date

two - Second date

Returns:

Differences between the two dates as a string.

difference

public static <D extends Date> String difference(D from,
 int days)

Get the difference between two dates as a string representation in the form "3Y 2M 4D" (meaning 3 years, 2 months, 4 days). The respective parts may be absent for zero values unless the result is just "0D".

Type Parameters:

D - Date-type

Parameters:

from - The first date

days - offset added to the date to get the second date

Returns:

Differences between the two dates as a string.

maximumDate

public static Date maximumDate()

Returns the maximum possible date value.

Returns:

the maximum date value available

getMonthNames

public static String[] getMonthNames()

Returns an array of month names.

Returns:

an array of Strings representing the names of the months.

getWeekNames

public static String[] getWeekNames()

Retrieves the names of the days in a week.

Returns:

a string array containing the names of the days in a week

dateFormat

public static DateFormat dateFormat()

Returns a clone of the Java DateFormat instance.

Returns:

a clone of the Java DateFormat instance.

dateTimeFormat

public static DateFormat dateTimeFormat()

Returns a clone of the default date and time format.

Returns:

a clone of the default date and time format.

timeFormat

public static DateFormat timeFormat()

Retrieves a clone of the time format used by the application.

Returns:

A clone of the time format.

timeFormat24

public static DateFormat timeFormat24()

Returns a cloned instance of the default 24-hour time format. The returned DateFormat object can be used to format time values in the 24-hour format.

Returns:

a cloned instance of the default 24-hour time format

toGMT

public static <D extends Date> D toGMT(D date,
 String fromTimeZone)

Converts a given date to Greenwich Meantime (GMT) based on the provided time zone.

Type Parameters:

D - the type of the date parameter, which must extend java.util.Date

Parameters:

date - the date to be converted to GMT

fromTimeZone - the time zone of the given date, represented as a string

Returns:

the converted date in GMT

toGMT

public static <D extends Date> D toGMT(D date,
 TimeZone fromTimeZone)

Converts the given date to GMT (Greenwich Mean Time) by converting its time zone to GMT.

Type Parameters:

D - the type of the date parameter, which must extend java.util.Date

Parameters:

date - The date to be converted to GMT.

fromTimeZone - The time zone of the given date. If null, the default time zone of the system will be used.

Returns:

The converted date in GMT.

toGMT

public static <D extends Date> D toGMT(D date,
 ZoneId fromZoneId)

Converts a given date to the GMT timezone.

Type Parameters:

D - The type of the date.

Parameters:

date - The date to convert.

fromZoneId - The zoneId of the date to convert from.

Returns:

The converted date in the GMT timezone.

toGMT

public static <D extends Date> D toGMT(D date,
 ZoneOffset fromZoneOffset)

Converts the given date to GMT (Greenwich Mean Time) by subtracting the offset caused by the provided ZoneOffset.

Type Parameters:

D - the type of date to convert, must extend java.util.Date

Parameters:

date - the date to convert to GMT

fromZoneOffset - the ZoneOffset that represents the offset from GMT

Returns:

the converted date in GMT

fromGMT

public static <D extends Date> D fromGMT(D date,
 String toTimeZone)

Converts the given date from GMT to the specified time zone.

Type Parameters:

D - the type of date to convert, must extend java.util.Date

Parameters:

date - The date object to convert from GMT to the specified time zone. Cannot be null.

toTimeZone - The target time zone to convert the date to. Can be null.

Returns:

The converted date object in the specified time zone, or the original date object if toTimeZone is null.

fromGMT

public static <D extends Date> D fromGMT(D date,
 TimeZone toTimeZone)

Converts a given date from GMT (Greenwich Mean Time) to the specified time zone.

Type Parameters:

D - the type of date to convert, must extend java.util.Date

Parameters:

date - the date to be converted from GMT

toTimeZone - the target time zone to convert the date to, can be null

Returns:

the converted date in the specified time zone

fromGMT

public static <D extends Date> D fromGMT(D date,
 ZoneId toZoneId)

Converts the given date from GMT (Greenwich Mean Time) to a specified time zone.

Type Parameters:

D - the type of the date object

Parameters:

date - the date to be converted

toZoneId - the target time zone ID to convert the date to

Returns:

the converted date in the specified time zone

fromGMT

public static <D extends Date> D fromGMT(D dateGMT,
 ZoneOffset toZoneOffset)

Translates a given date from GMT to a specified time zone.

Type Parameters:

D - the type of date to convert, must extend java.util.Date

Parameters:

dateGMT - the date to be translated from GMT to the specified time zone.

toZoneOffset - the time zone offset to be applied to the date. If null, the date will not be modified.

Returns:

the translated date in the specified time zone, or the original date if no offset is provided.