edu.ie3.util

Class TimeUtil

java.lang.Object

edu.ie3.util.TimeUtil

public class TimeUtil
extends java.lang.Object

Utility class that can either be used with default values withDefaults or as a self parametrized class.

Field Summary

Fields

Modifier and Type	Field and Description
static TimeUtil	withDefaults

Constructor Summary

Constructors

Constructor and Description
TimeUtil(java.time.ZoneId zoneId, java.util.Locale locale, java.lang.String dtfPattern)

Method Summary

Modifier and Type	Method and Description
java.time.format.DateTimeFormatter	getDateTimeFormatter()
java.lang.String	getDtfPattern()
java.util.Locale	getLocale()
int	getQuarterHourOfDay(java.time.ZonedDateTime time) Determines the number of quarter hour of the day (starting with 0).
java.util.TimeZone	getTimeZone()
java.time.ZoneId	getZoneId()
static java.time.ZonedDateTime	toNextFull(java.time.ZonedDateTime zdt, java.time.temporal.ChronoUnit chronoUnit) Moves the given zoned date time to the next full unit (e.g.
java.lang.String	toString(java.time.Instant instant) Converts a given instant to a time string
java.lang.String	toString(java.time.ZonedDateTime zonedDateTime) Converts a given ZoneDateTime to a time string
java.time.ZonedDateTime	toZonedDateTime(java.lang.String timeString) Returns an ZoneDateTime based on a given String, which can be understood by the class private DateTimeFormatter
long	zonedDateTimeDifference(java.time.ZonedDateTime startDateTime, java.time.ZonedDateTime endDateTime, java.time.temporal.ChronoUnit unit) Calculate the difference between two [[ZonedDateTime]]s and return the difference in the given [[ChronoUnit]]
long	zonedDateTimeDifferenceInSeconds(java.time.ZonedDateTime startDateTime, java.time.ZonedDateTime endDateTime) Calculate the difference between two given [[ZonedDateTime]]s and return the difference in seconds

Methods inherited from class java.lang.Object

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

Field Detail

withDefaults

public static final TimeUtil withDefaults

Constructor Detail

TimeUtil

public TimeUtil(java.time.ZoneId zoneId,
                java.util.Locale locale,
                java.lang.String dtfPattern)

Method Detail

toString

public java.lang.String toString(java.time.Instant instant)

Converts a given instant to a time string

Parameters:

instant - Instant to be converted to String

Returns:

A String of the given Instant

toString

public java.lang.String toString(java.time.ZonedDateTime zonedDateTime)

Converts a given ZoneDateTime to a time string

Parameters:

zonedDateTime - Instant to be converted to String

Returns:

A String of the given Instant

toZonedDateTime

public java.time.ZonedDateTime toZonedDateTime(java.lang.String timeString)

Returns an ZoneDateTime based on a given String, which can be understood by the class private DateTimeFormatter

Parameters:

timeString - String to convert to Instant

Returns:

Instant object

getZoneId

public java.time.ZoneId getZoneId()

getTimeZone

public java.util.TimeZone getTimeZone()

getLocale

public java.util.Locale getLocale()

getDtfPattern

public java.lang.String getDtfPattern()

getDateTimeFormatter

public java.time.format.DateTimeFormatter getDateTimeFormatter()

getQuarterHourOfDay

public int getQuarterHourOfDay(java.time.ZonedDateTime time)

Determines the number of quarter hour of the day (starting with 0). The definition of quarter hour relates to something comparable than a right open interval. Example: 00:00:00 = 0 ... 00:14:59 = 0 00:15:00 = 1

Parameters:

time - Time, from which the number of quarter hour may be determined

Returns:

Number of the quarter hour of the day

zonedDateTimeDifferenceInSeconds

public long zonedDateTimeDifferenceInSeconds(java.time.ZonedDateTime startDateTime,
                                             java.time.ZonedDateTime endDateTime)

Calculate the difference between two given [[ZonedDateTime]]s and return the difference in seconds

Parameters:

startDateTime - the start date time

endDateTime - the end date time

Returns:

the difference between the provided start and end date time in seconds

zonedDateTimeDifference

public long zonedDateTimeDifference(java.time.ZonedDateTime startDateTime,
                                    java.time.ZonedDateTime endDateTime,
                                    java.time.temporal.ChronoUnit unit)

Calculate the difference between two [[ZonedDateTime]]s and return the difference in the given [[ChronoUnit]]

Parameters:

startDateTime - the start date time

endDateTime - the end date time

unit - the chrono unit that should be used returned

Returns:

the difference between the provided start and end date time in the provided chrono unit

toNextFull

public static java.time.ZonedDateTime toNextFull(java.time.ZonedDateTime zdt,
                                                 java.time.temporal.ChronoUnit chronoUnit)

Moves the given zoned date time to the next full unit (e.g. hour)

Parameters:

zdt - Zoned date time to alter

chronoUnit - Next full time unit

Returns:

Next full chrono unit, if it does not meet yet