Package com.thanlinardos.spring_enterprise_library.time.utils

Class InstantUtils

java.lang.Object

com.thanlinardos.spring_enterprise_library.time.utils.InstantUtils

public abstract class InstantUtils
extends Object

Utility class for working with Instant objects.

Constructor Summary

Constructors

Constructor	Description
InstantUtils()

Method Summary

Modifier and Type	Method	Description
static Instant	addDefault(Instant instant, long amount)	Adds the given amount of the default accuracy to the given instant.
static Instant	addSingle(Instant instant)	Adds a single unit of the default accuracy to the given instant.
static Instant	fromEndOfLocalDate(LocalDate date)	Converts a LocalDate to an Instant at the end of the given date's day in the default time zone and represented with the default accuracy.
static Instant	fromEndOfLocalDate(LocalDate date, TimeUnit accuracy, ZoneOffset zoneOffset)	Converts a LocalDate to an Instant at the end of the day in the specified ZoneOffset and accuracy.
static Instant	fromLocalDate(LocalDate date)	Converts a LocalDate to an Instant at the start of the day in the default time zone.
static Instant	fromLocalDate(LocalDate date, ZoneOffset zoneOffset)	Converts a LocalDate to an Instant at the start of the day in the specified ZoneOffset.
static boolean	isAfterNullAsMax(Instant instant1, Instant instant2)	Checks if instant1 is after instant2, treating null as TimeFactory.getMaxInstant().
static boolean	isAfterOrEqual(Instant instant1, Instant instant2)	Checks if instant1 is after or equal to instant2, treating null as TimeFactory.getMinInstant().
static boolean	isBeforeNullAsMin(Instant instant1, Instant instant2)	Checks if instant1 is before instant2, treating null as TimeFactory.getMinInstant().
static boolean	isBeforeOrEqual(Instant instant1, Instant instant2)	Checks if instant1 is before or equal to instant2, treating null as TimeFactory.getMaxInstant().
static Instant	maxNullAsMax(Instant instant1, Instant instant2)	Returns the maximum of two Instants, treating null as TimeFactory.getMaxInstant().
static Instant	maxNullAsMin(Instant instant1, Instant instant2)	Returns the maximum of two Instants, treating null as TimeFactory.getMaxInstant().
static Instant	minNullAsMax(Instant instant1, Instant instant2)	Returns the minimum of two Instants, treating null as TimeFactory.getMaxInstant().
static Instant	minNullAsMin(Instant instant1, Instant instant2)	Returns the minimum of two Instants, treating null as TimeFactory.getMinInstant().
static Instant	parseInstant(String start)	Parses an Instant string using the default parser in Instant.parse(CharSequence).
static Instant	parseInstant(String date, Function<String,Instant> parser)	Parses an Instant string using the provided parser function.
static Instant	subtractDefault(Instant instant, long amount)	Adds the given amount of the default accuracy to the given instant.
static Instant	subtractDefault(Instant temporal, long amount, TimeUnit accuracy)	Subtracts the given amount of the specified accuracy from the given instant.
static Instant	subtractSingle(Instant instant)	Subtracts a single unit of the default accuracy from the given instant.
static Instant	subtractSingle(Instant temporal, TimeUnit accuracy)	Subtracts a single unit of the specified accuracy from the given instant.
static LocalDate	toLocalDate(Instant instant)	Converts an Instant to a LocalDate in the default time zone.

Methods inherited from class java.lang.Object

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

Constructor Details

InstantUtils

public InstantUtils()

Method Details

parseInstant

public static Instant parseInstant(String start)

Parses an Instant string using the default parser in Instant.parse(CharSequence).

Parameters:

start - the Instant string to parse.

Returns:

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

parseInstant

public static Instant parseInstant(@Nullable
 String date,
 Function<String,Instant> parser)

Parses an Instant string using the provided parser function.

Parameters:

date - the Instant string to parse.

parser - the function to parse the Instant.

Returns:

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

fromLocalDate

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

Converts a LocalDate to an Instant at the start of the day in the default time zone.

Parameters:

date - the LocalDate to convert.

Returns:

the corresponding Instant, or null if the input date is null.

fromLocalDate

@Nullable
public static Instant fromLocalDate(@Nullable
 LocalDate date,
 ZoneOffset zoneOffset)

Converts a LocalDate to an Instant at the start of the day in the specified ZoneOffset.

Parameters:

date - the LocalDate to convert.

zoneOffset - the ZoneOffset to use for conversion.

Returns:

the corresponding Instant, or null if the input date is null.

fromEndOfLocalDate

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

Converts a LocalDate to an Instant at the end of the given date's day in the default time zone and represented with the default accuracy.

For example, if the default accuracy is MILLISECONDS, then result will be: 'dateT23:59:59.999'.

Parameters:

date - the LocalDate to convert.

Returns:

the corresponding Instant, or null if the input date is null.

fromEndOfLocalDate

@Nullable
public static Instant fromEndOfLocalDate(@Nullable
 LocalDate date,
 TimeUnit accuracy,
 ZoneOffset zoneOffset)

Converts a LocalDate to an Instant at the end of the day in the specified ZoneOffset and accuracy. See fromEndOfLocalDate(LocalDate) for details.

Parameters:

date - the LocalDate to convert.

accuracy - the TimeUnit accuracy to use to represent the resulting Instant.

zoneOffset - the ZoneOffset to use for conversion.

Returns:

the corresponding Instant, or null if the input date is null.

toLocalDate

@Nullable
public static LocalDate toLocalDate(@Nullable
 Instant instant)

Converts an Instant to a LocalDate in the default time zone.

Parameters:

instant - the Instant to convert.

Returns:

the corresponding LocalDate, or null if the input Instant is null.

isBeforeNullAsMin

public static boolean isBeforeNullAsMin(@Nullable
 Instant instant1,
 @Nullable
 Instant instant2)

Checks if instant1 is before instant2, treating null as TimeFactory.getMinInstant().

Parameters:

instant1 - The first date to compare.

instant2 - The second date to compare.

Returns:

true if instant1 is before instant2, false otherwise.

isAfterNullAsMax

public static boolean isAfterNullAsMax(@Nullable
 Instant instant1,
 @Nullable
 Instant instant2)

Checks if instant1 is after instant2, treating null as TimeFactory.getMaxInstant().

Parameters:

instant1 - The first date to compare.

instant2 - The second date to compare.

Returns:

true if instant1 is after instant2, false otherwise.

isBeforeOrEqual

public static boolean isBeforeOrEqual(@Nullable
 Instant instant1,
 @Nullable
 Instant instant2)

Checks if instant1 is before or equal to instant2, treating null as TimeFactory.getMaxInstant().

Parameters:

instant1 - The first date to compare.

instant2 - The second date to compare.

Returns:

true if instant1 is before or equal to instant2, false otherwise.

isAfterOrEqual

public static boolean isAfterOrEqual(@Nullable
 Instant instant1,
 @Nullable
 Instant instant2)

Checks if instant1 is after or equal to instant2, treating null as TimeFactory.getMinInstant().

Parameters:

instant1 - The first date to compare.

instant2 - The second date to compare.

Returns:

true if instant1 is after or equal to instant2, false otherwise.

maxNullAsMax

public static Instant maxNullAsMax(@Nullable
 Instant instant1,
 @Nullable
 Instant instant2)

Returns the maximum of two Instants, treating null as TimeFactory.getMaxInstant().

Parameters:

instant1 - the first instant.

instant2 - the second instant.

Returns:

the maximum of the two instants.

minNullAsMin

public static Instant minNullAsMin(@Nullable
 Instant instant1,
 @Nullable
 Instant instant2)

Returns the minimum of two Instants, treating null as TimeFactory.getMinInstant().

Parameters:

instant1 - the first instant.

instant2 - the second instant.

Returns:

the minimum of the two instants.

maxNullAsMin

public static Instant maxNullAsMin(@Nullable
 Instant instant1,
 @Nullable
 Instant instant2)

Returns the maximum of two Instants, treating null as TimeFactory.getMaxInstant().

Parameters:

instant1 - the first instant.

instant2 - the second instant.

Returns:

the maximum of the two instants.

minNullAsMax

public static Instant minNullAsMax(@Nullable
 Instant instant1,
 @Nullable
 Instant instant2)

Returns the minimum of two Instants, treating null as TimeFactory.getMaxInstant().

Parameters:

instant1 - the first instant.

instant2 - the second instant.

Returns:

the minimum of the two instants.

addDefault

@Nullable
public static Instant addDefault(@Nullable
 Instant instant,
 long amount)

Adds the given amount of the default accuracy to the given instant.

Parameters:

instant - the instant to add to.

amount - the amount to add.

Returns:

the resulting instant, or null if the input instant is null.

addSingle

@Nullable
public static Instant addSingle(@Nullable
 Instant instant)

Adds a single unit of the default accuracy to the given instant.

Parameters:

instant - the instant to add to.

Returns:

the resulting instant, or null if the input instant is null.

subtractDefault

@Nullable
public static Instant subtractDefault(@Nullable
 Instant instant,
 long amount)

Adds the given amount of the default accuracy to the given instant.

Parameters:

instant - the instant to add to.

amount - the amount to add.

Returns:

the resulting instant, or null if the input instant is null.

subtractSingle

@Nullable
public static Instant subtractSingle(@Nullable
 Instant instant)

Subtracts a single unit of the default accuracy from the given instant.

Parameters:

instant - the instant to subtract from.

Returns:

the resulting instant, or null if the input instant is null.

subtractDefault

@Nullable
public static Instant subtractDefault(@Nullable
 Instant temporal,
 long amount,
 TimeUnit accuracy)

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

Parameters:

temporal - the instant to subtract from.

amount - the amount to subtract.

accuracy - the TimeUnit accuracy to use for the subtraction.

Returns:

the resulting instant, or null if the input instant is null.

subtractSingle

@Nullable
public static Instant subtractSingle(@Nullable
 Instant temporal,
 TimeUnit accuracy)

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

Parameters:

temporal - the instant to subtract from.

accuracy - the TimeUnit accuracy to use for the subtraction.

Returns:

the resulting instant, or null if the input instant is null.