DateAndTime (Wrangler Core 4.8.0 API)

java.lang.Object
- io.cdap.functions.DateAndTime

```
public final class DateAndTime
extends Object
```
Collection of useful expression functions made available in the context of an expression. set-column column datetime:CurrentDate() set-column :column exp:{ datetime:CurrrentDate() }

Constructor Summary

Constructors
Constructor and Description

DateAndTime()

Constructors
Constructor and Description
`DateAndTime()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.time.LocalDate`	`CurrentDate()`
`static java.time.LocalDateTime`	`CurrentDateTime()`
`static java.time.LocalTime`	`CurrentTime()`
`static long`	`CurrentTimeMS()`
`static java.time.ZonedDateTime`	`CurrentTimestamp()`
`static long`	`CurrentTimestampMS()`
`static long`	`CurrentTimestampNano()`
`static java.time.LocalDate`	`DateFromComponents(Integer year, Integer month, Integer day)` Creates a `LocalDate` from the components year, month, and day.
`static java.time.LocalDate`	`DateFromDaysSince(Integer days)` Returns a date object by adding an integer to a current date.
`static java.time.LocalDate`	`DateFromDaysSince(Integer days, java.time.LocalDate baseline)` Returns a date object by adding an integer to a baseline date.
`static java.time.LocalDate`	`DateFromJulianDay(Long julianDay)` Returns a date from the given Julian day number.
`static java.time.LocalDate`	`DateOffsetByComponents(java.time.LocalDate baseline, Integer yearOffset, Integer monthOffset, Integer daysOffset)` Returns the given date, with offsets applied from the given year offset, month offset, and day of month offset.
`static java.time.LocalDate`	`DateOffsetByDays(java.time.LocalDate date, Integer daysOffset)` Returns the given date offset by the given number of days.
`static java.time.LocalDateTime`	`DateTimeFromEpoch(Long epochTimestamp)` Returns a datetime from the given epoch time specified in seconds.
`static java.time.LocalDateTime`	`DateTimeFromSecondsSince(Integer seconds, java.time.LocalDateTime time)` Returns a datetime that is derived from the number of seconds from the base datetime object.
`static java.time.LocalDateTime`	`DateTimeFromTime(java.time.LocalTime time, java.time.LocalDateTime datetime)` Returns a datetime from the given time and datetime objects.
`static java.time.LocalDateTime`	`DateTimeOffsetByComponents(java.time.LocalDateTime datetime, Integer yearOffset, Integer monthOffset, Integer dayOfMonthOffset, Integer hourOffset, Integer minOffset, Integer secondOffset)` Returns a datetime from the given time and the offsets.
`static java.time.LocalDateTime`	`DateTimeOffsetBySeconds(java.time.LocalDateTime datetime, Integer secondsOffset)`
`static Integer`	`DaysInMonth(java.time.LocalDate date)` Returns the number of days in the month in the given base date.
`static Integer`	`DaysInYear(java.time.LocalDate date)` Returns the number of days in the year in the given base date.
`static Long`	`DaysSinceFromDate(java.time.LocalDate source, java.time.LocalDate destination)` Returns the number of days from the source date to the given date.
`static Long`	`EpochFromDateTime(java.time.LocalDateTime datetime)`
`static Long`	`EpochFromTimestamp(java.time.ZonedDateTime timestamp)`
`static long`	`EpochSeconds()`
`static java.time.LocalDate`	`GetDate(String date)` Return the `LocalDate` the string represents.
`static java.time.LocalDateTime`	`GetDateTime(java.time.LocalDate date, java.time.LocalTime time)` Returns a datetime from the given date and time.
`static java.time.LocalDateTime`	`GetDateTime(String date)` Return the `LocalDateTime` the string represents.
`static java.time.LocalTime`	`GetTime(String time)` Return the `LocalTime` the string represents.
`static Integer`	`HoursFromTime(java.time.LocalTime time)` Returns the hours portion of a time.
`static Long`	`JulianDayFromDate(java.time.LocalDate date)` Returns a Julian day number from the given date.
`static Integer`	`MicroSecondsFromTime(java.time.LocalTime time)` Returns the microsecond portion of a time.
`static Integer`	`MidnightSecondsFromTime(java.time.LocalTime time)` Returns the number of seconds from midnight to the given time.
`static Integer`	`MilliSecondsFromTime(java.time.LocalTime time)` Returns the millisecond portion of a time.
`static Integer`	`MinutesFromTime(java.time.LocalTime time)` Returns the minutes portion of a time.
`static Integer`	`MonthDayFromDate(java.time.LocalDate date)` Returns the day of the month from the given date.
`static Integer`	`MonthFromDate(java.time.LocalDate date)` Returns the month number from the given date.
`static Integer`	`NanoSecondsFromTime(java.time.LocalTime time)` Returns the Nanosecond portion of a time.
`static java.time.LocalDate`	`NextWeekdayFromDate(java.time.LocalDate source, String textDayOfWeek)` Returns the date of the specified day of the week soonest after the source date.
`static java.time.LocalDate`	`NthWeekdayFromDate(java.time.LocalDate source, String textDayOfWeek, Number offset)` Returns the date of the specified day of the week offset by the specified number of weeks from the source date.
`static java.time.LocalDate`	`PreviousWeekdayFromDate(java.time.LocalDate source, String textDayOfWeek)` Returns the date of the specified day of the week that is the most recent day before the source date.
`static Integer`	`SecondsFromTime(java.time.LocalTime time)` Returns the seconds portion of a time.
`static Long`	`SecondsSinceFromDateTime(java.time.LocalDateTime source, java.time.LocalDateTime destination)` Returns the number of seconds between two datetime objects.
`static String`	`TimeDate()`
`static java.time.LocalTime`	`TimeFromComponents(Integer hours, Integer mins, Integer seconds, Integer microseconds)` Returns a time from the given hours, minutes, seconds, and microseconds, given as four separate values.
`static java.time.LocalTime`	`TimeFromMidnightSeconds(Integer seconds)` Returns the time given the number of seconds since midnight.
`static java.time.LocalTime`	`TimeOffsetByComponents(java.time.LocalTime time, Integer hour, Integer min, Integer seconds)` Returns the time, with offsets applied from the base time.
`static Integer`	`WeekdayFromDate(java.time.LocalDate date)`
`static Integer`	`WeekdayFromDate(java.time.LocalDate date, String startOfWeek)`
`static Integer`	`YeardayFromDate(java.time.LocalDate date)`
`static Integer`	`YearFromDate(java.time.LocalDate date)`
`static Integer`	`YearweekFromDate(java.time.LocalDate date)`

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

- Constructor Detail
  - DateAndTime
```
public DateAndTime()
```
- Method Detail
  - GetDate
```
public static java.time.LocalDate GetDate(String date)
```
    Return the LocalDate the string represents. If the string is null, this method will return null.
  - GetTime
```
public static java.time.LocalTime GetTime(String time)
```
    Return the LocalTime the string represents. If the string is null, this method will return null.
  - GetDateTime
```
public static java.time.LocalDateTime GetDateTime(String date)
```
    Return the LocalDateTime the string represents. If the string is null, this method will return null.
  - CurrentDate
```
public static java.time.LocalDate CurrentDate()
```
    Returns:
    
    returns current date with time.
  - CurrentTime
```
public static java.time.LocalTime CurrentTime()
```
    Returns:
    
    return current localtime.
  - CurrentTimeMS
```
public static long CurrentTimeMS()
```
    Returns:
    
    return current time in milliseconds.
  - CurrentDateTime
```
public static java.time.LocalDateTime CurrentDateTime()
```
    Returns:
    
    return current data & time.
  - CurrentTimestamp
```
public static java.time.ZonedDateTime CurrentTimestamp()
```
    Returns:
    
    return current timestamp in default timezone.
  - EpochSeconds
```
public static long EpochSeconds()
```
    Returns:
    
    return current epoch seconds.
  - CurrentTimestampMS
```
public static long CurrentTimestampMS()
```
    Returns:
    
    return current data & time in milliseconds.
  - CurrentTimestampNano
```
public static long CurrentTimestampNano()
```
    Returns:
    
    return current data & time in Nanoseconds.
  - DateFromDaysSince
```
public static java.time.LocalDate DateFromDaysSince(Integer days)
```
    Returns a date object by adding an integer to a current date. If this integer is null, current date will be returned. The integer can be negative to return a date that is earlier than the current date.
    
    Parameters:
    
    days - to be added to current date.
    
    Returns:
    
    returns a LocalDate by adding days to current date.
  - DateFromDaysSince
```
public static java.time.LocalDate DateFromDaysSince(Integer days,
                                                    java.time.LocalDate baseline)
```
    Returns a date object by adding an integer to a baseline date. If this integer is null, baseline date will be returned. The integer can be negative to return a date that is earlier than the baseline date. If baseline is null, the current date will be used. If days is null, it will be treated as 0.
    
    Parameters:
    
    days - to be added to the baseline date.
    
    baseline - date to which 'days' are added.
    
    Returns:
    
    days added positive or negative to the baseline date.
  - DateFromComponents
```
public static java.time.LocalDate DateFromComponents(Integer year,
                                                     Integer month,
                                                     Integer day)
```
    Creates a LocalDate from the components year, month, and day. If any input is null, null will be returned.
    
    Parameters:
    
    year - to used for date.
    
    month - to be used for date.
    
    day - to be used for date
    
    Returns:
    
    a instance of LocalDate
  - DateFromJulianDay
```
public static java.time.LocalDate DateFromJulianDay(Long julianDay)
```
    Returns a date from the given Julian day number. The day number will be treated as 0 if it is null.
    
    Parameters:
    
    julianDay - Julian day number
    
    Returns:
    
    a instance of LocalDate that represents the Julian day.
  - DateOffsetByComponents
```
public static java.time.LocalDate DateOffsetByComponents(java.time.LocalDate baseline,
                                                         Integer yearOffset,
                                                         Integer monthOffset,
                                                         Integer daysOffset)
```
    Returns the given date, with offsets applied from the given year offset, month offset, and day of month offset. offsets are given as three separate values. The offset values can each be positive, zero, or negative. If base line is null, null will be returned. If the offset is null, it will be treated as 0.
    
    Parameters:
    
    baseline - baseline date.
    
    yearOffset - year offset to be applied.
    
    monthOffset - month offset to be applied.
    
    daysOffset - days offset to be applied.
    
    Returns:
    
    Modified date with offsets applied.
  - DaysSinceFromDate
```
public static Long DaysSinceFromDate(java.time.LocalDate source,
                                     java.time.LocalDate destination)
```
    Returns the number of days from the source date to the given date. If any date is null, null will be returned.
    
    Parameters:
    
    source - date of LocalDate type.
    
    destination - date of LocalDate type.
    
    Returns:
    
    Number of days between the dates.
  - DaysInMonth
```
public static Integer DaysInMonth(java.time.LocalDate date)
```
    Returns the number of days in the month in the given base date. If date is null, null will be returned.
    
    Parameters:
    
    date - date of LocalDate type.
    
    Returns:
    
    number of days in the month in the given base date.
  - DaysInYear
```
public static Integer DaysInYear(java.time.LocalDate date)
```
    Returns the number of days in the year in the given base date. If date is null, null will be returned.
    
    Parameters:
    
    date - date of LocalDate type.
    
    Returns:
    
    number of days in the year in the given base date.
  - DateOffsetByDays
```
public static java.time.LocalDate DateOffsetByDays(java.time.LocalDate date,
                                                   Integer daysOffset)
```
    Returns the given date offset by the given number of days. The offset value can be positive, zero, or negative. If date is null, null will be returned. If offset is null, it will be treated as 0.
    
    Parameters:
    
    date - date of LocalDate type.
    
    daysOffset - days to offset the baseline date.
    
    Returns:
    
    Date offset by days.
  - HoursFromTime
```
public static Integer HoursFromTime(java.time.LocalTime time)
```
    Returns the hours portion of a time. If time is null, null will be returned.
    
    Parameters:
    
    time - of LocalTime type.
    
    Returns:
    
    hour portion of time
  - JulianDayFromDate
```
public static Long JulianDayFromDate(java.time.LocalDate date)
```
    Returns a Julian day number from the given date. If date is null, null will be returned.
    
    Parameters:
    
    date - of LocalDate type.
    
    Returns:
    
    Julian day number.
  - NanoSecondsFromTime
```
public static Integer NanoSecondsFromTime(java.time.LocalTime time)
```
    Returns the Nanosecond portion of a time. If time is null, null will be returned.
    
    Parameters:
    
    time - of LocalTime type.
    
    Returns:
    
    nanosecond portion of time.
  - MicroSecondsFromTime
```
public static Integer MicroSecondsFromTime(java.time.LocalTime time)
```
    Returns the microsecond portion of a time. If time is null, null will be returned.
    
    Parameters:
    
    time - of LocalTime type.
    
    Returns:
    
    microsecond portion of time.
  - MilliSecondsFromTime
```
public static Integer MilliSecondsFromTime(java.time.LocalTime time)
```
    Returns the millisecond portion of a time. If time is null, null will be returned.
    
    Parameters:
    
    time - of LocalTime type.
    
    Returns:
    
    millisecond portion of time.
  - MidnightSecondsFromTime
```
public static Integer MidnightSecondsFromTime(java.time.LocalTime time)
```
    Returns the number of seconds from midnight to the given time. If time is null, null will be returned.
    
    Parameters:
    
    time - of LocalTime type.
    
    Returns:
    
    seconds from midnight
  - MinutesFromTime
```
public static Integer MinutesFromTime(java.time.LocalTime time)
```
    Returns the minutes portion of a time. If time is null, null will be returned.
    
    Parameters:
    
    time - of LocalTime type.
    
    Returns:
    
    minute of time.
  - MonthDayFromDate
```
public static Integer MonthDayFromDate(java.time.LocalDate date)
```
    Returns the day of the month from the given date. If date is null, null will be returned.
    
    Parameters:
    
    date - of LocalDate type.
    
    Returns:
    
    month of give date.
  - MonthFromDate
```
public static Integer MonthFromDate(java.time.LocalDate date)
```
    Returns the month number from the given date. If date is null, null will be returned.
    
    Parameters:
    
    date - of LocalDate type.
    
    Returns:
    
    month value in date.
  - NextWeekdayFromDate
```
public static java.time.LocalDate NextWeekdayFromDate(java.time.LocalDate source,
                                                      String textDayOfWeek)
```
    Returns the date of the specified day of the week soonest after the source date. The day of the week is specified as the full name, for example, thursday, or a three-letter abbreviation, for example, thu. If source is null, null will be returned. If the day of the week is null, source will be returned.
    
    Parameters:
    
    source - of LocalDate type.
    
    textDayOfWeek - text day of the week.
    
    Returns:
    
    earliest day from the date.
  - NthWeekdayFromDate
```
public static java.time.LocalDate NthWeekdayFromDate(java.time.LocalDate source,
                                                     String textDayOfWeek,
                                                     Number offset)
```
    Returns the date of the specified day of the week offset by the specified number of weeks from the source date. The day of the week is specified as the full name, for example, thursday, or a three-letter abbreviation, for example, thu. The offset values can be positive, negative, or zero. If source is null, null will be returned. If textDayOfWeek is null, source will be returned. If offset is null, it will be treated as 0.
    
    Parameters:
    
    source - of LocalDate type.
    
    textDayOfWeek - Display week of day string
    
    offset - offset week.
    
    Returns:
    
    date of the specified day of the week offset
  - PreviousWeekdayFromDate
```
public static java.time.LocalDate PreviousWeekdayFromDate(java.time.LocalDate source,
                                                          String textDayOfWeek)
```
    Returns the date of the specified day of the week that is the most recent day before the source date. The day of the week is specified as the full name, for example, thursday, or a three-letter abbreviation, for example, thu. If source is null, null will be returned. If the day of the week is null, source will be returned.
    
    Parameters:
    
    source - of LocalDate type.
    
    textDayOfWeek - Display week of day string
    
    Returns:
    
    previous day of the week.
  - SecondsFromTime
```
public static Integer SecondsFromTime(java.time.LocalTime time)
```
    Returns the seconds portion of a time. If time is null, null will be returned.
    
    Parameters:
    
    time - of LocalTime type.
    
    Returns:
    
    second portion of time.
  - SecondsSinceFromDateTime
```
public static Long SecondsSinceFromDateTime(java.time.LocalDateTime source,
                                            java.time.LocalDateTime destination)
```
    Returns the number of seconds between two datetime objects. If either datetime is null, null will be returned.
    
    Parameters:
    
    source - a LocalDateTime type
    
    destination - a LocalDateTime type
    
    Returns:
    
    number of seconds between two datetimes.
  - TimeDate
```
public static String TimeDate()
```
    Returns:
    
    Returns the system time and date as a formatted string.
  - TimeFromComponents
```
public static java.time.LocalTime TimeFromComponents(Integer hours,
                                                     Integer mins,
                                                     Integer seconds,
                                                     Integer microseconds)
```
    Returns a time from the given hours, minutes, seconds, and microseconds, given as four separate values. If any input is null, null will be returned.
    
    Parameters:
    
    hours - component of LocalTime
    
    mins - component of LocalTime
    
    seconds - component of LocalTime
    
    microseconds - component of LocalTime
    
    Returns:
    
    a instance of LocalTime
  - TimeFromMidnightSeconds
```
public static java.time.LocalTime TimeFromMidnightSeconds(Integer seconds)
```
    Returns the time given the number of seconds since midnight. If seconds is null, midnight will be returned.
    
    Parameters:
    
    seconds - since midnight.
    
    Returns:
    
    time since midnight.
  - TimeOffsetByComponents
```
public static java.time.LocalTime TimeOffsetByComponents(java.time.LocalTime time,
                                                         Integer hour,
                                                         Integer min,
                                                         Integer seconds)
```
    Returns the time, with offsets applied from the base time. hour offset, minute offset, and second offset each given as separate values. The seconds offset can include partial seconds. If time is null, null will be returned. If the offset is null, it will be treated as 0.
    
    Parameters:
    
    time - baseline LocalTime
    
    hour - offset to added to baseline.
    
    min - offset to added to baseline.
    
    seconds - offset to added to baseline.
    
    Returns:
    
    hour, min and second added to baseline.
  - GetDateTime
```
public static java.time.LocalDateTime GetDateTime(java.time.LocalDate date,
                                                  java.time.LocalTime time)
```
    Returns a datetime from the given date and time. If any input is null, null will be returned.
    
    Parameters:
    
    date - a instance of LocalDate
    
    time - a instance of LocalTime
    
    Returns:
    
    a instance of LocalDateTime
  - DateTimeFromSecondsSince
```
public static java.time.LocalDateTime DateTimeFromSecondsSince(Integer seconds,
                                                               java.time.LocalDateTime time)
```
    Returns a datetime that is derived from the number of seconds from the base datetime object. If time is null, null will be returned. If seconds is null, time will be returned.
    
    Parameters:
    
    seconds - to be added to base datetime.
    
    time - base datetime.
    
    Returns:
    
    datetime with seconds added to base time.
  - DateTimeFromEpoch
```
public static java.time.LocalDateTime DateTimeFromEpoch(Long epochTimestamp)
```
    Returns a datetime from the given epoch time specified in seconds. This method assumes the timestamp is in UTC time. If timestamp is null, null will be returned.
    
    Parameters:
    
    epochTimestamp - specified in seconds.
    
    Returns:
    
    a instance LocalDateTime
  - DateTimeFromTime
```
public static java.time.LocalDateTime DateTimeFromTime(java.time.LocalTime time,
                                                       java.time.LocalDateTime datetime)
```
    Returns a datetime from the given time and datetime objects. The value in the time object overwrites the time value in the datetime object so that only the date part is used from the datetime. If datetime is null, null will be returned. If time is null, datetime will be returned.
    
    Parameters:
    
    time - to replace in datetime
    
    datetime - who's datetime has to replaced.
    
    Returns:
    
    modified datetime.
  - DateTimeOffsetByComponents
```
public static java.time.LocalDateTime DateTimeOffsetByComponents(java.time.LocalDateTime datetime,
                                                                 Integer yearOffset,
                                                                 Integer monthOffset,
                                                                 Integer dayOfMonthOffset,
                                                                 Integer hourOffset,
                                                                 Integer minOffset,
                                                                 Integer secondOffset)
```
    Returns a datetime from the given time and the offsets. If datetime is null, null will be returned. If offset is null, it will be treated as 0.
    
    Returns:
    
    Returns the datetime, with offsets applied from the base datetime.
  - DateTimeOffsetBySeconds
```
public static java.time.LocalDateTime DateTimeOffsetBySeconds(java.time.LocalDateTime datetime,
                                                              Integer secondsOffset)
```
    Returns:
    
    Returns the datetime, with offsets applied from the base datetime with seconds offset. If datetime is null, null will be returned. If seconds is null, it will be treated as 0.
  - EpochFromDateTime
```
public static Long EpochFromDateTime(java.time.LocalDateTime datetime)
```
    Returns:
    
    Returns a UNIX epoch time in seconds from the given datetime in UTC time. If datetime is null, null will be returned.
  - EpochFromTimestamp
```
public static Long EpochFromTimestamp(java.time.ZonedDateTime timestamp)
```
    Returns:
    
    Returns a UNIX epoch time in seconds from the given timestamp in UTC time. If timestamp is null, null will be returned.
  - WeekdayFromDate
```
public static Integer WeekdayFromDate(java.time.LocalDate date,
                                      String startOfWeek)
```
    Returns:
    
    Returns the day number of the week from the given date with start of week provided. If date is null, null will be returned. If startOfWeek is null, the date's day number of the week will be returned.
  - WeekdayFromDate
```
public static Integer WeekdayFromDate(java.time.LocalDate date)
```
    Returns:
    
    Returns the day number of the week from the given date. If date is null, null will be returned.
  - YeardayFromDate
```
public static Integer YeardayFromDate(java.time.LocalDate date)
```
    Returns:
    
    Returns the day number in the year from the given date. If date is null, null will be returned.
  - YearFromDate
```
public static Integer YearFromDate(java.time.LocalDate date)
```
    Returns:
    
    Returns the year from the given date. If date is null, null will be returned
  - YearweekFromDate
```
public static Integer YearweekFromDate(java.time.LocalDate date)
```
    Returns:
    
    Returns the week number in the year from the given date. If date is null, null will be returned.

Class DateAndTime

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DateAndTime

Method Detail

GetDate

GetTime

GetDateTime

CurrentDate

CurrentTime

CurrentTimeMS

CurrentDateTime

CurrentTimestamp

EpochSeconds

CurrentTimestampMS

CurrentTimestampNano

DateFromDaysSince

DateFromDaysSince

DateFromComponents

DateFromJulianDay

DateOffsetByComponents

DaysSinceFromDate

DaysInMonth

DaysInYear

DateOffsetByDays

HoursFromTime

JulianDayFromDate

NanoSecondsFromTime

MicroSecondsFromTime

MilliSecondsFromTime

MidnightSecondsFromTime

MinutesFromTime

MonthDayFromDate

MonthFromDate

NextWeekdayFromDate

NthWeekdayFromDate

PreviousWeekdayFromDate

SecondsFromTime

SecondsSinceFromDateTime

TimeDate

TimeFromComponents

TimeFromMidnightSeconds

TimeOffsetByComponents

GetDateTime

DateTimeFromSecondsSince

DateTimeFromEpoch

DateTimeFromTime

DateTimeOffsetByComponents

DateTimeOffsetBySeconds

EpochFromDateTime

EpochFromTimestamp

WeekdayFromDate

WeekdayFromDate

YeardayFromDate

YearFromDate

YearweekFromDate