DateUtils (Teamscale Check Framework API)

java.lang.Object
- org.conqat.lib.commons.date.DateUtils

public class DateUtils
extends java.lang.Object

Utility methods for working on date objects.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DateUtils.CurrentDateFactory` A factory returning the current date.
`static class`	`DateUtils.FixedDateFactory` A factory returning a fixed date.

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`MILLIS_PER_DAY` The number of milliseconds per day
`static long`	`MILLIS_PER_HOUR` The number of milliseconds per hour
`static long`	`MILLIS_PER_MINUTE` The number of milliseconds per minute
`static long`	`MILLIS_PER_SECOND` The number of milliseconds per second
`static long`	`NANOS_PER_SECOND` The number of nanoseconds per second

Constructor Summary

Constructors
Constructor and Description

DateUtils()

Constructors
Constructor and Description
`DateUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.util.Date`	`addDaysToDate(java.util.Date date, int days)` Create a new date and add `days` to it.
`static java.util.Date`	`createDate(int day, int month, int year)` Create a date.
`static java.time.ZonedDateTime`	`createZonedDateTimeForTimestamp(long timestamp)` Creates a new `ZonedDateTime` for the given timestamp.
`static long`	`daysToMilliseconds(int days)` Converts the given number of days into milliseconds.
`static long`	`diff(java.util.Date earlier, java.util.Date later, java.util.concurrent.TimeUnit timeUnit)` Returns the difference between two dates in the given time unit.
`static long`	`diffDays(java.util.Date earlier, java.util.Date later)` Returns the difference between two dates in days.
`static java.lang.String`	`formatDate(long timestamp, java.lang.String pattern)` Takes a `timestamp` in milliseconds and returns formatted string representation of date using given pattern.
`static java.lang.String`	`formatDurationHumanReadable(java.time.Duration duration)` Formats a duration in a human-readable way (e.g.
`static java.lang.String`	`formatTimestampToDate(long timestamp)` Formats the given timestamp as date YYYY-MM-DD
`static java.util.Date`	`getDateBefore(int days)` Retrieves the date which is exactly the given number of days before now.
`static java.util.List<java.util.Date>`	`getDatePointsInTimespan(java.util.Date startDate, java.util.Date endDate, int daysBetweenDatePoints, boolean includeEndDate)` Get an ordered list of dates that includes `startDate`, date points in between start and end date and the `endDate` if `includeEndDate` is true.
`static java.util.Date`	`getEarliest(java.util.Collection<java.util.Date> dates)` Returns the earliest date in a collection of dates
`static java.util.Date`	`getLatest(java.util.Collection<java.util.Date> dates)` Returns the latest date in a collection of dates
`static java.util.Date`	`getNow()` Returns the current time as a `Date` object.
`static java.util.Date`	`getNowWithoutTime()` `getNow()` truncated to the begin of day.
`static java.lang.Long`	`getTimeOfDate(java.util.Date date)` Get the timestamp of a date.
`static java.lang.String`	`getUiFormattedDateString(long milliseconds)` Takes a `timestamp` in milliseconds, creates a date based on this timestamp and returns the UI formatted String representation of this date.
`static long`	`hoursToMilliseconds(int hours)` Converts the given number of hours into milliseconds.
`static java.util.Date`	`incrementByOneDay(java.util.Date date)` Returns a new Date that is one day later than the given date.
`static java.util.Date`	`max(java.util.Date d1, java.util.Date d2)` Returns the later of two dates or null, if one of the dates is null.
`static java.util.Date`	`min(java.util.Date d1, java.util.Date d2)` Returns the earlier of two dates, or null, if one of the dates is null
`static long`	`minutesToMilliseconds(int minutes)` Converts the given number of minutes into milliseconds.
`static double`	`nanosToSeconds(long nanos)` Converts nano seconds to seconds.
`static java.util.Date`	`subtractDaysFromDate(java.util.Date date, int days)` Create a new date and subtracts `days` from it.
`static IFactory<java.util.Date,NeverThrownRuntimeException>`	`testcode_getNowFactory()` Returns the factory that affects the notion of "now" in `getNow()` .
`static void`	`testcode_resetNowFactory()` Reset the now factory to the default one.
`static void`	`testcode_setFixedDate(java.util.Date date)` Sets the given fixed date for "now" in `getNow()`.
`static void`	`testcode_setNowFactory(IFactory<java.util.Date,NeverThrownRuntimeException> nowFactory)` Sets the factory that affects the notion of "now" in `getNow()`.
`static java.util.Date`	`truncateToBeginOfDay(java.util.Date date)` Returns a normalized version of the given date.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MILLIS_PER_SECOND
```
public static final long MILLIS_PER_SECOND
```
    The number of milliseconds per second
    
    See Also:
    
    Constant Field Values
  - NANOS_PER_SECOND
```
public static final long NANOS_PER_SECOND
```
    The number of nanoseconds per second
    
    See Also:
    
    Constant Field Values
  - MILLIS_PER_MINUTE
```
public static final long MILLIS_PER_MINUTE
```
    The number of milliseconds per minute
    
    See Also:
    
    Constant Field Values
  - MILLIS_PER_HOUR
```
public static final long MILLIS_PER_HOUR
```
    The number of milliseconds per hour
    
    See Also:
    
    Constant Field Values
  - MILLIS_PER_DAY
```
public static final long MILLIS_PER_DAY
```
    The number of milliseconds per day
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DateUtils
```
public DateUtils()
```
- Method Detail
  - getLatest
```
public static java.util.Date getLatest(java.util.Collection<java.util.Date> dates)
```
    Returns the latest date in a collection of dates
  - getEarliest
```
public static java.util.Date getEarliest(java.util.Collection<java.util.Date> dates)
```
    Returns the earliest date in a collection of dates
  - min
```
public static java.util.Date min(java.util.Date d1,
                                 java.util.Date d2)
```
    Returns the earlier of two dates, or null, if one of the dates is null
  - max
```
public static java.util.Date max(java.util.Date d1,
                                 java.util.Date d2)
```
    Returns the later of two dates or null, if one of the dates is null.
  - getDateBefore
```
public static java.util.Date getDateBefore(int days)
```
    Retrieves the date which is exactly the given number of days before now.
  - getNow
```
public static java.util.Date getNow()
```
    Returns the current time as a Date object. This is preferred to directly calling the Date.Date() constructor, as this method provides a central entry point that allows the notion of time to be tweaked (e.g. for testing, when we want a certain date to be returned). The behavior of this method can be affected either by calling the testcode_setNowFactory(IFactory) method, or by providing a fixed date in format "yyyyMMddHHmmss" as the system property "org.conqat.lib.commons.date.now".
  - getNowWithoutTime
```
public static java.util.Date getNowWithoutTime()
```
    getNow() truncated to the begin of day.
  - testcode_getNowFactory
```
public static IFactory<java.util.Date,NeverThrownRuntimeException> testcode_getNowFactory()
```
    Returns the factory that affects the notion of "now" in getNow() . This should be only called from test code!
  - testcode_setNowFactory
```
public static void testcode_setNowFactory(IFactory<java.util.Date,NeverThrownRuntimeException> nowFactory)
```
    Sets the factory that affects the notion of "now" in getNow(). This should be only called from test code!
  - testcode_setFixedDate
```
public static void testcode_setFixedDate(java.util.Date date)
```
    Sets the given fixed date for "now" in getNow(). This should be only called from test code! It is absolutely necessary to call the reset method afterwards in order to prevent test interactions over the statically shared nowFactory.
  - testcode_resetNowFactory
```
public static void testcode_resetNowFactory()
```
    Reset the now factory to the default one. It is also a good idea to reset the license manager after calling this, if the test case might have created a new global instance of the license manager after setting a fixed date (because chances are that the date influences the validity of the used license).
  - incrementByOneDay
```
public static java.util.Date incrementByOneDay(java.util.Date date)
```
    Returns a new Date that is one day later than the given date.
  - truncateToBeginOfDay
```
public static java.util.Date truncateToBeginOfDay(java.util.Date date)
```
    Returns a normalized version of the given date. Normalization is done by removing all time-of-day information.
  - formatTimestampToDate
```
public static java.lang.String formatTimestampToDate(long timestamp)
```
    Formats the given timestamp as date YYYY-MM-DD
  - daysToMilliseconds
```
public static long daysToMilliseconds(int days)
```
    Converts the given number of days into milliseconds.
  - hoursToMilliseconds
```
public static long hoursToMilliseconds(int hours)
```
    Converts the given number of hours into milliseconds.
  - minutesToMilliseconds
```
public static long minutesToMilliseconds(int minutes)
```
    Converts the given number of minutes into milliseconds.
  - diff
```
public static long diff(java.util.Date earlier,
                        java.util.Date later,
                        java.util.concurrent.TimeUnit timeUnit)
```
    Returns the difference between two dates in the given time unit.
  - diffDays
```
public static long diffDays(java.util.Date earlier,
                            java.util.Date later)
```
    Returns the difference between two dates in days.
  - addDaysToDate
```
public static java.util.Date addDaysToDate(java.util.Date date,
                                           int days)
```
    Create a new date and add days to it.
  - subtractDaysFromDate
```
public static java.util.Date subtractDaysFromDate(java.util.Date date,
                                                  int days)
```
    Create a new date and subtracts days from it.
  - getDatePointsInTimespan
```
public static java.util.List<java.util.Date> getDatePointsInTimespan(java.util.Date startDate,
                                                                     java.util.Date endDate,
                                                                     int daysBetweenDatePoints,
                                                                     boolean includeEndDate)
```
    Get an ordered list of dates that includes startDate, date points in between start and end date and the endDate if includeEndDate is true.
  - getTimeOfDate
```
public static java.lang.Long getTimeOfDate(java.util.Date date)
```
    Get the timestamp of a date. Returns null if date is null.
  - createDate
```
public static java.util.Date createDate(int day,
                                        int month,
                                        int year)
```
    Create a date.
    
    Parameters:
    
    month - zero-based index
  - getUiFormattedDateString
```
public static java.lang.String getUiFormattedDateString(long milliseconds)
```
    Takes a timestamp in milliseconds, creates a date based on this timestamp and returns the UI formatted String representation of this date. This used a fixed English locale.
  - formatDate
```
public static java.lang.String formatDate(long timestamp,
                                          java.lang.String pattern)
```
    Takes a timestamp in milliseconds and returns formatted string representation of date using given pattern. The pattern format is the one used in Java DateTimeFormatter. Uses English locale.
  - formatDurationHumanReadable
```
public static java.lang.String formatDurationHumanReadable(java.time.Duration duration)
```
    Formats a duration in a human-readable way (e.g. 1h 20min 5s 123ms).
  - nanosToSeconds
```
public static double nanosToSeconds(long nanos)
```
    Converts nano seconds to seconds.
  - createZonedDateTimeForTimestamp
```
public static java.time.ZonedDateTime createZonedDateTimeForTimestamp(long timestamp)
```
    Creates a new ZonedDateTime for the given timestamp.

Class DateUtils

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MILLIS_PER_SECOND

NANOS_PER_SECOND

MILLIS_PER_MINUTE

MILLIS_PER_HOUR

MILLIS_PER_DAY

Constructor Detail

DateUtils

Method Detail

getLatest

getEarliest

min

max

getDateBefore

getNow

getNowWithoutTime

testcode_getNowFactory

testcode_setNowFactory

testcode_setFixedDate

testcode_resetNowFactory

incrementByOneDay

truncateToBeginOfDay

formatTimestampToDate

daysToMilliseconds

hoursToMilliseconds

minutesToMilliseconds

diff

diffDays

addDaysToDate

subtractDaysFromDate

getDatePointsInTimespan

getTimeOfDate

createDate

getUiFormattedDateString

formatDate

formatDurationHumanReadable

nanosToSeconds

createZonedDateTimeForTimestamp