Package com.thanlinardos.spring_enterprise_library.time

Record Class TimeProviderImpl

java.lang.Object

java.lang.Record

com.thanlinardos.spring_enterprise_library.time.TimeProviderImpl

Record Components:

zoneId - the time zone to use for date and time operations.

accuracy - the default accuracy to use for date and time operations.

maxDate - the maximum date that can be used in the system.

minDate - the minimum date that can be used in the system.

maxDateTime - the maximum date time that can be used in the system.

minDateTime - the minimum date time that can be used in the system.

All Implemented Interfaces:

TimeProvider

public record TimeProviderImpl(ZoneId zoneId, TimeUnit accuracy, LocalDate maxDate, LocalDate minDate, LocalDateTime maxDateTime, LocalDateTime minDateTime)
extends Record
implements TimeProvider

Default implementation of TimeProvider interface.

Constructor Summary

Constructors

Constructor	Description
TimeProviderImpl(ZoneId zoneId, TimeUnit accuracy, LocalDate maxDate, LocalDate minDate, LocalDateTime maxDateTime, LocalDateTime minDateTime)	Creates an instance of a TimeProviderImpl record class.

Method Summary

Modifier and Type	Method	Description
TimeUnit	accuracy()	Returns the value of the accuracy record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
LocalDateTime	fromMillis(long milliseconds)	Obtains an instance of LocalDateTime from provided milliseconds in the specified time-zone
ChronoUnit	getChronoAccuracy()	Gets the accuracy of the TimeProvider as ChronoUnit
LocalDate	getCurrentDate()	Obtains the current date from the system clock in the specified time-zone
LocalDateTime	getCurrentDateTime()	Obtains the current date-time from the system clock in the specified time-zone
Instant	getCurrentInstant()	Obtains the current instant from the system clock in the default time-zone
long	getCurrentTimeMillis()	Obtains the current time in milliseconds from the system clock in the specified time-zone.
ZoneOffset	getDefaultZone()	Gets the default ZoneOffset of the TimeProvider
LocalDateTime	getEndOfDay(LocalDate date)	Returns LocalDateTime with the time of the end of the day based on given LocalDate NOTE: Returned time will be 23:59 (where LocalTime.MAX is 23:59:59.999999999)
LocalDate	getFirstDayOfQuarter(LocalDate dateInQuarter)	Returns new instance of LocalDate with first day of quarter for given date.
LocalDate	getFirstDayOfYear(LocalDate date)	Return new instance of LocalDate with first day of the year.
LocalDate	getLastDayOfQuarter(LocalDate dateInQuarter)	Returns new instance of LocalDate with last day of quarter for given date.
LocalDate	getLastDayOfYear(LocalDate date)	Return new instance of LocalDate with last day of the year.
LocalDateTime	getStartOfDay(LocalDate date)	Returns the LocalDateTime with the start time of the day based on the given LocalDate
final int	hashCode()	Returns a hash code value for this object.
InstantInterval	instantFromNowPlusSeconds(long seconds)	Creates an InstantInterval starting from now plus the given seconds.
LocalDate	maxDate()	Returns the value of the maxDate record component.
LocalDateTime	maxDateTime()	Returns the value of the maxDateTime record component.
LocalDate	minDate()	Returns the value of the minDate record component.
LocalDateTime	minDateTime()	Returns the value of the minDateTime record component.
TimeInterval	timeFromNowPlusSeconds(long seconds)	Creates a TimeInterval starting from now plus the given seconds.
long	toMillis(LocalDateTime ldt)	Converts this LocalDateTime to the number of milliseconds from the epoch of 1970-01-01T00:00:00Z in the specified time-zone
final String	toString()	Returns a string representation of this record class.
ZoneId	zoneId()	Returns the value of the zoneId record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

TimeProviderImpl

public TimeProviderImpl(ZoneId zoneId,
 TimeUnit accuracy,
 LocalDate maxDate,
 LocalDate minDate,
 LocalDateTime maxDateTime,
 LocalDateTime minDateTime)

Creates an instance of a TimeProviderImpl record class.

Parameters:

zoneId - the value for the zoneId record component

accuracy - the value for the accuracy record component

maxDate - the value for the maxDate record component

minDate - the value for the minDate record component

maxDateTime - the value for the maxDateTime record component

minDateTime - the value for the minDateTime record component

Method Details

getDefaultZone

public ZoneOffset getDefaultZone()

Description copied from interface: TimeProvider

Gets the default ZoneOffset of the TimeProvider

Specified by:

getDefaultZone in interface TimeProvider

Returns:

the default ZoneOffset

getChronoAccuracy

public ChronoUnit getChronoAccuracy()

Description copied from interface: TimeProvider

Gets the accuracy of the TimeProvider as ChronoUnit

Specified by:

getChronoAccuracy in interface TimeProvider

Returns:

the accuracy as ChronoUnit

getCurrentDateTime

public LocalDateTime getCurrentDateTime()

Description copied from interface: TimeProvider

Obtains the current date-time from the system clock in the specified time-zone

Specified by:

getCurrentDateTime in interface TimeProvider

Returns:

the current date-time of specific time zone

getCurrentInstant

public Instant getCurrentInstant()

Description copied from interface: TimeProvider

Obtains the current instant from the system clock in the default time-zone

Specified by:

getCurrentInstant in interface TimeProvider

Returns:

the current instant of specific time zone

getCurrentDate

public LocalDate getCurrentDate()

Description copied from interface: TimeProvider

Obtains the current date from the system clock in the specified time-zone

Specified by:

getCurrentDate in interface TimeProvider

Returns:

the current date of specific time zone

getCurrentTimeMillis

public long getCurrentTimeMillis()

Description copied from interface: TimeProvider

Obtains the current time in milliseconds from the system clock in the specified time-zone.

Specified by:

getCurrentTimeMillis in interface TimeProvider

Returns:

the current time in milliseconds.

fromMillis

public LocalDateTime fromMillis(long milliseconds)

Description copied from interface: TimeProvider

Obtains an instance of LocalDateTime from provided milliseconds in the specified time-zone

Specified by:

fromMillis in interface TimeProvider

Parameters:

milliseconds - the milliseconds to convert

Returns:

LocalDateTime object from milliseconds

toMillis

public long toMillis(LocalDateTime ldt)

Description copied from interface: TimeProvider

Converts this LocalDateTime to the number of milliseconds from the epoch of 1970-01-01T00:00:00Z in the specified time-zone

Specified by:

toMillis in interface TimeProvider

Parameters:

ldt - the LocalDateTime to convert

Returns:

number of milliseconds from LocalDateTime object from epoch

getEndOfDay

public LocalDateTime getEndOfDay(LocalDate date)

Description copied from interface: TimeProvider

Returns LocalDateTime with the time of the end of the day based on given LocalDate NOTE: Returned time will be 23:59 (where LocalTime.MAX is 23:59:59.999999999)

Specified by:

getEndOfDay in interface TimeProvider

Parameters:

date - the given date

Returns:

number of milliseconds from LocalDateTime object from epoch

getStartOfDay

public LocalDateTime getStartOfDay(LocalDate date)

Description copied from interface: TimeProvider

Returns the LocalDateTime with the start time of the day based on the given LocalDate

Specified by:

getStartOfDay in interface TimeProvider

Parameters:

date - the given date

Returns:

number of milliseconds from LocalDateTime object from epoch

getFirstDayOfQuarter

public LocalDate getFirstDayOfQuarter(LocalDate dateInQuarter)

Description copied from interface: TimeProvider

Returns new instance of LocalDate with first day of quarter for given date.

getFirstDayOfQuarter(LocalDate.of(2016, 2, 29)) == LocalDate.of(2016,1,1) getFirstDayOfQuarter(LocalDate.of(2017, 10, 16)) == LocalDate.of(2017,10,1)

Specified by:

getFirstDayOfQuarter in interface TimeProvider

Parameters:

dateInQuarter - - any date in the quarter

Returns:

First day of quarter

getLastDayOfQuarter

public LocalDate getLastDayOfQuarter(LocalDate dateInQuarter)

Description copied from interface: TimeProvider

Returns new instance of LocalDate with last day of quarter for given date.

getFirstDayOfQuarter(LocalDate.of(2016, 2, 29)) == LocalDate.of(2016, 3, 31) getFirstDayOfQuarter(LocalDate.of(2017, 10, 16)) == LocalDate.of(2017,12,31)

Specified by:

getLastDayOfQuarter in interface TimeProvider

Parameters:

dateInQuarter - - any date in the quarter

Returns:

First day of quarter

getFirstDayOfYear

public LocalDate getFirstDayOfYear(LocalDate date)

Description copied from interface: TimeProvider

Return new instance of LocalDate with first day of the year.

Specified by:

getFirstDayOfYear in interface TimeProvider

Parameters:

date - - any date in the year

Returns:

First day of year

getLastDayOfYear

public LocalDate getLastDayOfYear(LocalDate date)

Description copied from interface: TimeProvider

Return new instance of LocalDate with last day of the year.

Specified by:

getLastDayOfYear in interface TimeProvider

Parameters:

date - - any date in the year

Returns:

First day of year

instantFromNowPlusSeconds

public InstantInterval instantFromNowPlusSeconds(long seconds)

Description copied from interface: TimeProvider

Creates an InstantInterval starting from now plus the given seconds.

Specified by:

instantFromNowPlusSeconds in interface TimeProvider

Parameters:

seconds - the number of seconds to add to the current instant.

Returns:

an InstantInterval starting from now plus the given seconds.

timeFromNowPlusSeconds

public TimeInterval timeFromNowPlusSeconds(long seconds)

Description copied from interface: TimeProvider

Creates a TimeInterval starting from now plus the given seconds.

Specified by:

timeFromNowPlusSeconds in interface TimeProvider

Parameters:

seconds - the number of seconds to add to the current time.

Returns:

a TimeInterval starting from now plus the given seconds.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

zoneId

public ZoneId zoneId()

Returns the value of the zoneId record component.

Specified by:

zoneId in interface TimeProvider

Returns:

the value of the zoneId record component

accuracy

public TimeUnit accuracy()

Returns the value of the accuracy record component.

Specified by:

accuracy in interface TimeProvider

Returns:

the value of the accuracy record component

maxDate

public LocalDate maxDate()

Returns the value of the maxDate record component.

Specified by:

maxDate in interface TimeProvider

Returns:

the value of the maxDate record component

minDate

public LocalDate minDate()

Returns the value of the minDate record component.

Specified by:

minDate in interface TimeProvider

Returns:

the value of the minDate record component

maxDateTime

public LocalDateTime maxDateTime()

Returns the value of the maxDateTime record component.

Specified by:

maxDateTime in interface TimeProvider

Returns:

the value of the maxDateTime record component

minDateTime

public LocalDateTime minDateTime()

Returns the value of the minDateTime record component.

Specified by:

minDateTime in interface TimeProvider

Returns:

the value of the minDateTime record component