DateTimeUtil (iText - commons 9.6.0 API)

java.lang.Object
- com.itextpdf.commons.utils.DateTimeUtil

```
public final class DateTimeUtil
extends Object
```
This file is a helper class for internal usage only. Be aware that its API and functionality may be changed in future.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Calendar`	`addDaysToCalendar(Calendar calendar, int days)` Adds the specified amount of days to the given calendar field.
`static Date`	`addDaysToDate(Date date, int days)` Adds the specified amount of days to the given date.
`static Date`	`addMillisToDate(Date date, long millis)` Adds provided number of milliseconds to the Date.
`static Date`	`addYearsToDate(Date date, int years)` Adds the specified amount of years to the given date.
`static Date`	`createUtcDateTime(int year, int month, int day, int hour, int minute, int second)` Creates UTC Date based on provided parameters.
`static String`	`dateToString(Calendar date)` Converts `Calendar` date to string of "yyyy.MM.dd HH:mm:ss z" format.
`static String`	`format(Date date, String pattern)` Format passing date with specified pattern.
`static String`	`formatWithDefaultPattern(Date date)` Format passing date with default yyyy-MM-dd pattern.
`static Calendar`	`getCalendar(Date date)` Gets the date as `Calendar`.
`static Calendar`	`getCurrentTimeCalendar()` Gets a default `GregorianCalendar`.
`static Date`	`getCurrentTimeDate()` Gets current time consistently.
`static long`	`getCurrentTimeZoneOffset(Date date)` Gets the offset of time zone from UTC at the specified date.
`static LocalDateTime`	`getLocalDateTime()` Gets local current time consistently.
`static long`	`getRelativeTime(Date date)` Gets the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by specified date.
`static LocalDateTime`	`getTimeFromMillis(long milliseconds)` Gets the `LocalDateTime` from milliseconds.
`static double`	`getUtcMillisFromEpoch(Calendar calendar)` Gets the `Calendar` as UTC milliseconds from the epoch.
`static boolean`	`isInPast(Date date)` Defines if date is in past.
`static LocalDateTime`	`ofEpochSecondUTC(long epochSecond)` Gets the `LocalDateTime` from UTC seconds from the epoch.
`static Date`	`parse(String date, String format)` Parses passing date with specified format.
`static String`	`parseLocalDateTime(LocalDateTime dateTime, String format)` Parses `LocalDateTime` local date time according to specified format.
`static LocalDateTime`	`parseToLocalDateTime(String date, String format)` Parses date with specified format into `LocalDateTime`.
`static Date`	`parseWithDefaultPattern(String date)` Parses passing date with default yyyy-MM-dd pattern.
`static String`	`serializeDateToISO8601(LocalDateTime dateTime)` Serialize time using format YYYY-MM-DDTHH-MM-SS

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

- Method Detail
  - getUtcMillisFromEpoch
```
public static double getUtcMillisFromEpoch(Calendar calendar)
```
    Gets the Calendar as UTC milliseconds from the epoch.
    
    Parameters:
    
    calendar - the calendar to be converted to millis
    
    Returns:
    
    the date as UTC milliseconds from the epoch
  - ofEpochSecondUTC
```
public static LocalDateTime ofEpochSecondUTC(long epochSecond)
```
    Gets the LocalDateTime from UTC seconds from the epoch.
    
    Parameters:
    
    epochSecond - the UTC milliseconds from the epoch
    
    Returns:
    
    local time from UTC seconds
  - getCalendar
```
public static Calendar getCalendar(Date date)
```
    Gets the date as Calendar.
    
    Parameters:
    
    date - the date to be returned as Calendar
    
    Returns:
    
    the date as Calendar
  - getCurrentTimeCalendar
```
public static Calendar getCurrentTimeCalendar()
```
    Gets a default GregorianCalendar.
    
    Returns:
    
    a default GregorianCalendar using the current time in the default time zone with the default locale
  - getCurrentTimeDate
```
public static Date getCurrentTimeDate()
```
    Gets current time consistently.
    
    Returns:
    
    the time at which it was allocated, measured to the nearest millisecond
  - getLocalDateTime
```
public static LocalDateTime getLocalDateTime()
```
    Gets local current time consistently.
    
    Returns:
    
    LocalDateTime at which it was allocated, measured to the nearest millisecond
  - addDaysToCalendar
```
public static Calendar addDaysToCalendar(Calendar calendar,
                                         int days)
```
    Adds the specified amount of days to the given calendar field.
    
    Parameters:
    
    calendar - the calendar field where to add
    
    days - the amount of days to be added
    
    Returns:
    
    the time at which it was allocated, measured to the nearest millisecond
  - isInPast
```
public static boolean isInPast(Date date)
```
    Defines if date is in past.
    
    Parameters:
    
    date - the date to be compared with current date
    
    Returns:
    
    true if given date is in past, false instead
  - getRelativeTime
```
public static long getRelativeTime(Date date)
```
    Gets the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by specified date.
    
    Parameters:
    
    date - the specified date to get time
    
    Returns:
    
    the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by the specified date
  - addMillisToDate
```
public static Date addMillisToDate(Date date,
                                   long millis)
```
    Adds provided number of milliseconds to the Date.
    
    Parameters:
    
    date - Date date to increase
    
    millis - number of milliseconds to add
    
    Returns:
    
    updated Date
  - addDaysToDate
```
public static Date addDaysToDate(Date date,
                                 int days)
```
    Adds the specified amount of days to the given date.
    
    Parameters:
    
    date - the specified date to add
    
    days - the amount of days to be added
    
    Returns:
    
    a Date object representing the calendar's time value (millisecond offset from the Epoch)
  - addYearsToDate
```
public static Date addYearsToDate(Date date,
                                  int years)
```
    Adds the specified amount of years to the given date.
    
    Parameters:
    
    date - the specified date to add
    
    years - the amount of years to be added
    
    Returns:
    
    a Date object representing the calendar's time value (millisecond offset from the Epoch)
  - parseWithDefaultPattern
```
public static Date parseWithDefaultPattern(String date)
```
    Parses passing date with default yyyy-MM-dd pattern.
    
    Parameters:
    
    date - is date to be parse
    
    Returns:
    
    parse date
  - parse
```
public static Date parse(String date,
                         String format)
```
    Parses passing date with specified format.
    
    Parameters:
    
    date - the date to be parsed
    
    format - the format of parsing the date
    
    Returns:
    
    parsed date
  - parseToLocalDateTime
```
public static LocalDateTime parseToLocalDateTime(String date,
                                                 String format)
```
    Parses date with specified format into LocalDateTime.
    
    Parameters:
    
    date - String date to parse
    
    format - String parsing format
    
    Returns:
    
    LocalDateTime parsed date
  - parseLocalDateTime
```
public static String parseLocalDateTime(LocalDateTime dateTime,
                                        String format)
```
    Parses LocalDateTime local date time according to specified format.
    
    Parameters:
    
    dateTime - LocalDateTime to parse
    
    format - String parsing format
    
    Returns:
    
    parse date time as String
  - formatWithDefaultPattern
```
public static String formatWithDefaultPattern(Date date)
```
    Format passing date with default yyyy-MM-dd pattern.
    
    Parameters:
    
    date - the date to be formatted
    
    Returns:
    
    formatted date
  - format
```
public static String format(Date date,
                            String pattern)
```
    Format passing date with specified pattern.
    
    Parameters:
    
    date - date to be formatted
    
    pattern - pattern for format
    
    Returns:
    
    formatted date
  - getCurrentTimeZoneOffset
```
public static long getCurrentTimeZoneOffset(Date date)
```
    Gets the offset of time zone from UTC at the specified date.
    
    Parameters:
    
    date - the date represented in milliseconds since January 1, 1970 00:00:00 GMT
    
    Returns:
    
    the offset of time zone from UTC at the specified date adjusted with the amount of daylight saving.
  - dateToString
```
public static String dateToString(Calendar date)
```
    Converts Calendar date to string of "yyyy.MM.dd HH:mm:ss z" format.
    
    Parameters:
    
    date - to convert.
    
    Returns:
    
    string date value.
  - getTimeFromMillis
```
public static LocalDateTime getTimeFromMillis(long milliseconds)
```
    Gets the LocalDateTime from milliseconds.
    
    Parameters:
    
    milliseconds - the UTC milliseconds from the epoch
    
    Returns:
    
    LocalDateTime converted from milliseconds
  - createUtcDateTime
```
public static Date createUtcDateTime(int year,
                                     int month,
                                     int day,
                                     int hour,
                                     int minute,
                                     int second)
```
    Creates UTC Date based on provided parameters.
    
    Parameters:
    
    year - as int to be created
    
    month - as int to be created
    
    day - as int to be created
    
    hour - as int to be created
    
    minute - as int to be created
    
    second - as int to be created
    
    Returns:
    
    UTC date
  - serializeDateToISO8601
```
public static String serializeDateToISO8601(LocalDateTime dateTime)
```
    Serialize time using format YYYY-MM-DDTHH-MM-SS
    
    Parameters:
    
    dateTime - local time to be converted
    
    Returns:
    
    serialized time

Class DateTimeUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getUtcMillisFromEpoch

ofEpochSecondUTC

getCalendar

getCurrentTimeCalendar

getCurrentTimeDate

getLocalDateTime

addDaysToCalendar

isInPast

getRelativeTime

addMillisToDate

addDaysToDate

addYearsToDate

parseWithDefaultPattern

parse

parseToLocalDateTime

parseLocalDateTime

formatWithDefaultPattern

format

getCurrentTimeZoneOffset

dateToString

getTimeFromMillis

createUtcDateTime

serializeDateToISO8601