Package com.thanlinardos.spring_enterprise_library.time.utils

Class DateTimeUtils

java.lang.Object

com.thanlinardos.spring_enterprise_library.time.utils.DateTimeUtils

public abstract class DateTimeUtils
extends Object

Utility class for working with LocalDateTime objects.

Constructor Summary

Constructors

Constructor	Description
DateTimeUtils()

Method Summary

Modifier and Type	Method	Description
static LocalDateTime	addDefault(LocalDateTime dateTime, long amount)	Adds the given amount of the accuracy configured in TimeFactory.getAccuracy() to the given dateTime.
static LocalDateTime	addSingle(LocalDateTime dateTime)	Adds a single unit of the accuracy configured in TimeFactory.getAccuracy() to the given dateTime.
static LocalDateTime	fromEndOfLocalDate(LocalDate date)	Converts a LocalDate to a LocalDateTime at the end of the day (23:59:59.999...).
static LocalDateTime	fromEndOfLocalDate(LocalDate date, TimeUnit accuracy)	Converts a LocalDate to a LocalDateTime at the end of the day (23:59:59.999...).
static LocalDateTime	fromLocalDate(LocalDate date)	Converts a LocalDate to a LocalDateTime at the start of the day (00:00).
static boolean	isAfterNullAsMax(LocalDateTime dateTime1, LocalDateTime dateTime2)	Checks if dateTime1 is after dateTime2, treating null as TimeFactory.getMaxDate().
static boolean	isAfterOrEqual(LocalDateTime dateTime1, LocalDateTime dateTime2)	Checks if dateTime1 is after or equal to dateTime2, treating null as TimeFactory.getMaxDate().
static boolean	isBeforeNullAsMin(LocalDateTime dateTime1, LocalDateTime dateTime2)	Checks if dateTime1 is before dateTime2, treating null as TimeFactory.getMinDate().
static boolean	isBeforeOrEqual(LocalDateTime dateTime1, LocalDateTime dateTime2)	Checks if dateTime1 is before or equal to dateTime2, treating null as TimeFactory.getMinDate().
static LocalDateTime	maxNullAsMax(LocalDateTime dateTime1, LocalDateTime dateTime2)	Returns the maximum of two dateTimes, treating null as TimeFactory.getMaxDateTime().
static LocalDateTime	maxNullAsMin(LocalDateTime dateTime1, LocalDateTime dateTime2)	Returns the maximum of two dateTimes, treating null as TimeFactory.getMinDateTime().
static LocalDateTime	minNullAsMax(LocalDateTime dateTime1, LocalDateTime dateTime2)	Returns the minimum of two dateTimes, treating null as TimeFactory.getMaxDateTime().
static LocalDateTime	minNullAsMin(LocalDateTime dateTime1, LocalDateTime dateTime2)	Returns the minimum of two dateTimes, treating null as TimeFactory.getMinDateTime().
static LocalDateTime	parseDateTime(String start)	Parses a dateTime string using the default parser in LocalDateTime.parse(CharSequence).
static LocalDateTime	parseDateTime(String date, Function<String,LocalDateTime> parser)	Parses an dateTime string using the provided parser function.
static LocalDateTime	subtractDefault(LocalDateTime dateTime, long amount)	Subtracts the given amount of the accuracy configured in TimeFactory.getAccuracy() from the given dateTime.
static LocalDateTime	subtractDefault(LocalDateTime dateTime, long amount, TimeUnit accuracy)	Subtracts the given amount of the specified accuracy from the given dateTime.
static LocalDateTime	subtractSingle(LocalDateTime dateTime)	Subtracts a single unit of the accuracy configured in TimeFactory.getAccuracy() from the given dateTime.
static LocalDateTime	subtractSingle(LocalDateTime dateTime, TimeUnit accuracy)	Subtracts a single unit of the specified accuracy from the given dateTime.
static LocalDate	toLocalDate(LocalDateTime dateTime)	Converts a LocalDateTime to a LocalDate with the default time zone.

Methods inherited from class java.lang.Object

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

Constructor Details

DateTimeUtils

public DateTimeUtils()

Method Details

parseDateTime

public static LocalDateTime parseDateTime(String start)

Parses a dateTime string using the default parser in LocalDateTime.parse(CharSequence).

Parameters:

start - the dateTime string to parse.

Returns:

the parsed dateTime, or null if the input string is empty.

parseDateTime

public static LocalDateTime parseDateTime(@Nullable
 String date,
 Function<String,LocalDateTime> parser)

Parses an dateTime string using the provided parser function.

Parameters:

date - the dateTime string to parse.

parser - the function to parse the dateTime.

Returns:

the parsed dateTime, or null if the input string is empty.

fromLocalDate

@Nullable
public static LocalDateTime fromLocalDate(@Nullable
 LocalDate date)

Converts a LocalDate to a LocalDateTime at the start of the day (00:00).

Parameters:

date - the date to convert.

Returns:

the converted dateTime, or null if the input date is null.

fromEndOfLocalDate

@Nullable
public static LocalDateTime fromEndOfLocalDate(@Nullable
 LocalDate date)

Converts a LocalDate to a LocalDateTime at the end of the day (23:59:59.999...). This is achieved by converting the date to the start of the next day and then subtracting a single unit of the default accuracy.

For example, if the default accuracy is set to MILLISECONDS, the resulting time will be 23:59:59.999.

Parameters:

date - the date to convert.

Returns:

the converted dateTime, or null if the input date is null.

fromEndOfLocalDate

@Nullable
public static LocalDateTime fromEndOfLocalDate(@Nullable
 LocalDate date,
 TimeUnit accuracy)

Converts a LocalDate to a LocalDateTime at the end of the day (23:59:59.999...). See fromEndOfLocalDate(LocalDate) for details.

Parameters:

date - the date to convert.

accuracy - the accuracy to use for subtraction, overriding the default.

Returns:

the converted dateTime, or null if the input date is null.

toLocalDate

@Nullable
public static LocalDate toLocalDate(@Nullable
 LocalDateTime dateTime)

Converts a LocalDateTime to a LocalDate with the default time zone.

Parameters:

dateTime - the dateTime to convert.

Returns:

the converted date, or null if the input dateTime is null.

isBeforeNullAsMin

public static boolean isBeforeNullAsMin(@Nullable
 LocalDateTime dateTime1,
 @Nullable
 LocalDateTime dateTime2)

Checks if dateTime1 is before dateTime2, treating null as TimeFactory.getMinDate().

Parameters:

dateTime1 - The first date to compare.

dateTime2 - The second date to compare.

Returns:

true if dateTime1 is before dateTime2, false otherwise.

isAfterNullAsMax

public static boolean isAfterNullAsMax(@Nullable
 LocalDateTime dateTime1,
 @Nullable
 LocalDateTime dateTime2)

Checks if dateTime1 is after dateTime2, treating null as TimeFactory.getMaxDate().

Parameters:

dateTime1 - The first date to compare.

dateTime2 - The second date to compare.

Returns:

true if dateTime1 is after dateTime2, false otherwise.

isBeforeOrEqual

public static boolean isBeforeOrEqual(@Nullable
 LocalDateTime dateTime1,
 @Nullable
 LocalDateTime dateTime2)

Checks if dateTime1 is before or equal to dateTime2, treating null as TimeFactory.getMinDate().

Parameters:

dateTime1 - The first date to compare.

dateTime2 - The second date to compare.

Returns:

true if dateTime1 is before or equal to dateTime2, false otherwise.

isAfterOrEqual

public static boolean isAfterOrEqual(@Nullable
 LocalDateTime dateTime1,
 @Nullable
 LocalDateTime dateTime2)

Checks if dateTime1 is after or equal to dateTime2, treating null as TimeFactory.getMaxDate().

Parameters:

dateTime1 - The first date to compare.

dateTime2 - The second date to compare.

Returns:

true if dateTime1 is after or equal to dateTime2, false otherwise.

maxNullAsMax

public static LocalDateTime maxNullAsMax(@Nullable
 LocalDateTime dateTime1,
 @Nullable
 LocalDateTime dateTime2)

Returns the maximum of two dateTimes, treating null as TimeFactory.getMaxDateTime().

Parameters:

dateTime1 - the first dateTime.

dateTime2 - the second dateTime.

Returns:

the maximum of the two dateTimes.

minNullAsMin

public static LocalDateTime minNullAsMin(@Nullable
 LocalDateTime dateTime1,
 @Nullable
 LocalDateTime dateTime2)

Returns the minimum of two dateTimes, treating null as TimeFactory.getMinDateTime().

Parameters:

dateTime1 - the first dateTime.

dateTime2 - the second dateTime.

Returns:

the minimum of the two dateTimes.

maxNullAsMin

public static LocalDateTime maxNullAsMin(@Nullable
 LocalDateTime dateTime1,
 @Nullable
 LocalDateTime dateTime2)

Returns the maximum of two dateTimes, treating null as TimeFactory.getMinDateTime().

Parameters:

dateTime1 - the first dateTime.

dateTime2 - the second dateTime.

Returns:

the maximum of the two dateTimes.

minNullAsMax

public static LocalDateTime minNullAsMax(@Nullable
 LocalDateTime dateTime1,
 @Nullable
 LocalDateTime dateTime2)

Returns the minimum of two dateTimes, treating null as TimeFactory.getMaxDateTime().

Parameters:

dateTime1 - the first dateTime.

dateTime2 - the second dateTime.

Returns:

the minimum of the two dateTimes.

addDefault

@Nullable
public static LocalDateTime addDefault(@Nullable
 LocalDateTime dateTime,
 long amount)

Adds the given amount of the accuracy configured in TimeFactory.getAccuracy() to the given dateTime.

For example if the default accuracy is MILLISECONDS, and the amount is 5, then 5 millis will be added to the given dateTime.

Parameters:

dateTime - the dateTime to add to.

amount - the amount to add.

Returns:

the adjusted dateTime, or null if the given dateTime is null.

addSingle

@Nullable
public static LocalDateTime addSingle(@Nullable
 LocalDateTime dateTime)

Adds a single unit of the accuracy configured in TimeFactory.getAccuracy() to the given dateTime.

Parameters:

dateTime - the dateTime to add to.

Returns:

the adjusted dateTime, or null if the given dateTime is null.

subtractDefault

@Nullable
public static LocalDateTime subtractDefault(@Nullable
 LocalDateTime dateTime,
 long amount)

Subtracts the given amount of the accuracy configured in TimeFactory.getAccuracy() from the given dateTime.

For example if the default accuracy is MILLISECONDS, and the amount is 5, then 5 millis will be subtracted from the given dateTime.

Parameters:

dateTime - the dateTime to subtract from.

amount - the amount to subtract.

Returns:

the adjusted dateTime, or null if the given dateTime is null.

subtractSingle

@Nullable
public static LocalDateTime subtractSingle(@Nullable
 LocalDateTime dateTime)

Subtracts a single unit of the accuracy configured in TimeFactory.getAccuracy() from the given dateTime.

Parameters:

dateTime - the dateTime to subtract from.

Returns:

the adjusted dateTime, or null if the given dateTime is null.

subtractDefault

@Nullable
public static LocalDateTime subtractDefault(@Nullable
 LocalDateTime dateTime,
 long amount,
 TimeUnit accuracy)

Subtracts the given amount of the specified accuracy from the given dateTime.

Parameters:

dateTime - the dateTime to subtract from.

amount - the amount to subtract.

accuracy - the accuracy to use for subtraction, overriding the default.

Returns:

the adjusted dateTime, or null if the given dateTime is null.

subtractSingle

@Nullable
public static LocalDateTime subtractSingle(@Nullable
 LocalDateTime dateTime,
 TimeUnit accuracy)

Subtracts a single unit of the specified accuracy from the given dateTime.

Parameters:

dateTime - the dateTime to subtract from.

accuracy - the accuracy to use for subtraction, overriding the default.

Returns:

the adjusted dateTime, or null if the given dateTime is null.