FlowableExpressionTimeUtils (Flowable Work 3.10.0)

java.lang.Object
- com.flowable.platform.expressions.FlowableExpressionTimeUtils

```
public class FlowableExpressionTimeUtils
extends Object
```
Expression Bean Name: flwTimeUtils Provides a number of date and time utilities which can be used in expressions. Please note that all operations use UTC as time zone. Example: #{flwTimeUtils.currentDate()} Example: #{flwTimeUtils.plusDays(now(), 10)}

Constructor Summary

Constructors
Constructor and Description

FlowableExpressionTimeUtils()

Constructors
Constructor and Description
`FlowableExpressionTimeUtils()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Date`	`asDate(Instant instant)` Converts an instant to a date.
`Object`	`atTime(Object dateOrInstant, int hours, int minutes, int seconds)` Sets the time of an instant to the specified hours, minutes and seconds.
`Object`	`atTimeWithTimeZone(Object dateOrInstant, int hours, int minutes, int seconds, String timezoneId)` Sets the time of an instant or date to the specified hours, minutes and seconds and returns that time in a specified time zone.
`Object`	`atTimeZone(Object dateOrInstant, String timeZoneId)` Returns an instant at a specified time zone.
`Instant`	`currentDate()` Returns the current date at 00:00 AM UTC.
`Date`	`dateFromTimestamp(long timestamp)` Returns a date from the number of seconds that have passed since the first of January 1970 (Unix Timestamp).
`Date`	`fullDateTimeDate(int year, int month, int day, int hour, int minute, int second)` Constructs an `Date` based on a given year, month, day, hour, minute and second.
`Instant`	`fullDateTimeInstant(int year, int month, int day, int hour, int minute, int second)` Constructs an `Instant` based on a given year, month, day, hour, minute and second.
`List<String>`	`getAvailableTimeZoneIds()` Receives a list of all available timeZoneIds maintained as specified by the IANA.
`int`	`getField(Object dateOrInstant, String chronoFieldString)` Obtains a "slice of time" by specifying a `ChronoField` as `String`.
`long`	`getFieldFromDurationBetweenDates(Object firstDateOrInstant, Object secondDateOrInstant, String chronoUnitString)` Gets the duration between two `Date` or `Instant` and extracts in a certain unit.
`long`	`getTimeZoneOffset(Object dateOrInstant, String timeZoneId)` Calculates the number of seconds a specific point in time at a specified time zone is set off from UTC.
`Instant`	`instantFromTimestamp(long timestamp)` Returns an instant from the number of seconds that have passed since the first of January 1970 (Unix Timestamp).
`boolean`	`isAfter(Object dateOrInstant, Object otherDateOrInstant)` Checks if the `Date` or `Instant` is after another `Date` or `Instant`.
`boolean`	`isAfterTime(Object dateOrInstant, String timeZoneId, int hours, int minutes, int seconds)` Checks if an `Date` or `Instant` is after a certain time in a given time zone.
`boolean`	`isBefore(Object dateOrInstant, Object otherDateOrInstant)` Checks if the instant is before another `Date` or `Instant`.
`boolean`	`isBeforeTime(Object dateOrInstant, String timeZoneId, int hours, int minutes, int seconds)` Checks if an `Date` or `Instant` is before a certain time in a given time zone.
`boolean`	`isWeekend(Object dateOrInstant)` Determines whether the current day is a weekend.
`Object`	`minusDays(Object dateOrInstant, long days)` Subtracts hours from an instant.
`Object`	`minusDuration(Object dateOrInstant, String iso8601Duration)` Subtracts an ISO8601-encoded duration from a `Date` or `Instant`.
`Object`	`minusHours(Object dateOrInstant, long hours)` Subtracts hours from an `Date` or `Instant`.
`Object`	`minusMinutes(Object dateOrInstant, long minutes)` Subtracts minutes from an `Date` or `Instant`.
`Object`	`minusMonths(Object dateOrInstant, long months)` Subtracts months from a `Date` or `Instant`.
`Object`	`minusSeconds(Object dateOrInstant, long seconds)` Subtracts seconds from an `Date` or `Instant`.
`Object`	`minusWeeks(Object dateOrInstant, long weeks)` Subtracts weeks to an `Date` or `Instant`.
`Object`	`minusYears(Object dateOrInstant, long years)` Subtracts years to a `Date` or `Instant`.
`Instant`	`now()` Returns the current date and time in UTC.
`Instant`	`parseInstant(String instantIsoString)`
`Instant`	`parseInstant(String instantString, String pattern)`
`Object`	`plusDays(Object dateOrInstant, long days)` Adds days to a `Date` or `Instant`.
`Object`	`plusDuration(Object dateOrInstant, String iso8601Duration)` Adds an ISO8601-encoded duration to a `Date` or `Instant`.
`Object`	`plusHours(Object dateOrInstant, long hours)` Adds hours to a `Date` or `Instant`.
`Object`	`plusMinutes(Object dateOrInstant, long minutes)` Adds minutes to an instant.
`Object`	`plusMonths(Object dateOrInstant, long months)` Adds months to a `Date` or `Instant`.
`Object`	`plusSeconds(Object dateOrInstant, long seconds)` Adds seconds to an `Date` or `Instant`.
`Object`	`plusWeeks(Object dateOrInstant, long weeks)` Adds weeks to a `Date` or `Instant`.
`Object`	`plusYears(Object dateOrInstant, long years)` Adds years from an `Date` or `Instant`.
`long`	`secondsBetweenDates(Object firstDateOrInstant, Object secondDateOrInstant)` Returns the number of seconds between two `Date` or `Instant`.
`long`	`secondsOfDuration(String iso8601Duration)` Gets the number of seconds in a ISO duration string, e.g.

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

- Constructor Detail
  - FlowableExpressionTimeUtils
```
public FlowableExpressionTimeUtils()
```
- Method Detail
  - parseInstant
```
public Instant parseInstant(String instantIsoString)
```
  - parseInstant
```
public Instant parseInstant(String instantString,
                            String pattern)
```
  - asDate
```
public Date asDate(Instant instant)
```
    Converts an instant to a date. This is useful in places where the old Java Date API is still used.
    
    Parameters:
    
    instant - the instant to be converted
    
    Returns:
    
    A Date based on the provided instant.
  - atTime
```
public Object atTime(Object dateOrInstant,
                     int hours,
                     int minutes,
                     int seconds)
```
    Sets the time of an instant to the specified hours, minutes and seconds. The ZoneOffset is UTC.
    
    Parameters:
    
    dateOrInstant - Base Date or Instant
    
    hours - the hours to be set
    
    minutes - the minutes to be set
    
    seconds - the seconds to be set
    
    Returns:
    
    A new Instant or Date at the specified time.
  - atTimeWithTimeZone
```
public Object atTimeWithTimeZone(Object dateOrInstant,
                                 int hours,
                                 int minutes,
                                 int seconds,
                                 String timezoneId)
```
    Sets the time of an instant or date to the specified hours, minutes and seconds and returns that time in a specified time zone. Example: Get the current date and time (now) in UTC, set the time to 10:00:00 AM and return the time in the time zone "Europe/Zurich" which will have an offset of either 1 or 2 hours, depending on the time of the year.
    
    Parameters:
    
    dateOrInstant - base Date or Instant
    
    hours - the hours to be set
    
    minutes - the minutes to be set
    
    seconds - the seconds to be set
    
    timezoneId - the time zone
    
    Returns:
    
    A new Date or Instant at the specified time (in UTC) at the specified time zone.
  - atTimeZone
```
public Object atTimeZone(Object dateOrInstant,
                         String timeZoneId)
```
    Returns an instant at a specified time zone.
    This is useful in application where more than one time zone is involved and users in different time zones
    receive dates offset to their specific time zones.
    Example: #{flwTimeUtils.atTimeZone(now(), 'Europe/Zurich')} will return the current time in Zurich
    A list of all available time zones can be received with getAvailableTimeZoneIds()
    A more or less up-to-date list can also be found here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones ATTENTION: This is for display purposes only, never store a date in a specific time zone!
    
    Parameters:
    
    dateOrInstant - base Date or Instant
    
    timeZoneId - the timeZone ID
    
    Returns:
    
    An Date or Instant, offset by the specified timeZoneId
  - getAvailableTimeZoneIds
```
public List<String> getAvailableTimeZoneIds()
```
    Receives a list of all available timeZoneIds maintained as specified by the IANA.
    Use this method if you want to provide a selection of time zones to an end user.
    
    Returns:
    
    A list of valid time zones usable with atTimeZone(Object, String)
  - getField
```
public int getField(Object dateOrInstant,
                    String chronoFieldString)
```
    Obtains a "slice of time" by specifying a ChronoField as String.
    The method supports both, the display name and the enum name of ChronoFields.
    Example: #{flwTimeUtils.getField(now(), "DAY_OF_WEEK")} to obtain the current day of the week
    Example: #{flwTimeUtils.getField(now(), "SECOND_OF_MINUTE")} to obtain the seconds in the current minute
    Example: #{flwTimeUtils.getField(now(), "AlignedWeekOfYear")} to obtain the calendar week. This example uses the display name of the Chrono Field.
    A list of all Chrono Fields can be found here:
    https://docs.oracle.com/javase/8/docs/api/java/time/temporal/ChronoField.html
    
    Parameters:
    
    dateOrInstant - base Date or Instant
    
    chronoFieldString - the name of a chrono field, see ChronoField
    
    Returns:
    
    An int representing the desired ChronoField of the instance in UTC.
  - isWeekend
```
public boolean isWeekend(Object dateOrInstant)
```
    Determines whether the current day is a weekend.
    
    Parameters:
    
    dateOrInstant - a Date or Instant
    
    Returns:
    
    A Boolean which indicates whether the current day is a weekend
  - fullDateTimeInstant
```
public Instant fullDateTimeInstant(int year,
                                   int month,
                                   int day,
                                   int hour,
                                   int minute,
                                   int second)
```
    Constructs an Instant based on a given year, month, day, hour, minute and second.
    
    Parameters:
    
    year - the year to use
    
    month - the month to use
    
    day - the day to use
    
    hour - the hour to use
    
    minute - the minute to use
    
    second - the second to use
    
    Returns:
    
    An Instant
  - fullDateTimeDate
```
public Date fullDateTimeDate(int year,
                             int month,
                             int day,
                             int hour,
                             int minute,
                             int second)
```
    Constructs an Date based on a given year, month, day, hour, minute and second.
    
    Parameters:
    
    year - the year to use
    
    month - the month to use
    
    day - the day to use
    
    hour - the hour to use
    
    minute - the minute to use
    
    second - the second to use
    
    Returns:
    
    An Date
  - plusSeconds
```
public Object plusSeconds(Object dateOrInstant,
                          long seconds)
```
    Adds seconds to an Date or Instant.
    
    Parameters:
    
    dateOrInstant - the basis Date or Instant
    
    seconds - the number of seconds to add
    
    Returns:
    
    A new Date or Instant
  - plusMinutes
```
public Object plusMinutes(Object dateOrInstant,
                          long minutes)
```
    Adds minutes to an instant.
    
    Parameters:
    
    dateOrInstant - the basis Date or Instant
    
    minutes - the number of minutes to add
    
    Returns:
    
    A new Date or Instant
  - plusHours
```
public Object plusHours(Object dateOrInstant,
                        long hours)
```
    Adds hours to a Date or Instant.
    
    Parameters:
    
    dateOrInstant - the basis Date or Instant
    
    hours - the number of hours to add
    
    Returns:
    
    A new Date or Instant
  - plusDays
```
public Object plusDays(Object dateOrInstant,
                       long days)
```
    Adds days to a Date or Instant.
    
    Parameters:
    
    dateOrInstant - the basis Date or Instant
    
    days - the number of days to add
    
    Returns:
    
    A new Instant
  - plusWeeks
```
public Object plusWeeks(Object dateOrInstant,
                        long weeks)
```
    Adds weeks to a Date or Instant.
    
    Parameters:
    
    dateOrInstant - the basis Date or Instant
    
    weeks - the number of weeks to add
    
    Returns:
    
    A new Date or Instant
  - plusMonths
```
public Object plusMonths(Object dateOrInstant,
                         long months)
```
    Adds months to a Date or Instant.
    
    Parameters:
    
    dateOrInstant - the basis Date or Instant
    
    months - the number of months to add
    
    Returns:
    
    A new Date or Instant
  - plusYears
```
public Object plusYears(Object dateOrInstant,
                        long years)
```
    Adds years from an Date or Instant.
    
    Parameters:
    
    dateOrInstant - the basis Date or Instant
    
    years - the number of years to add
    
    Returns:
    
    A new Date or Instant
  - plusDuration
```
public Object plusDuration(Object dateOrInstant,
                           String iso8601Duration)
```
    Adds an ISO8601-encoded duration to a Date or Instant.
    Example: #{flwTimeUtils.plusDuration(now(), 'P1Y')} adds a year
    Example: #{flwTimeUtils.plusDuration(now(), 'P14D')} adds 14 days
    Example: #{flwTimeUtils.plusDuration(now(), 'PT30M10S')} adds 30 minutes and ten seconds
    
    Parameters:
    
    dateOrInstant - the basis Date or Instant
    
    iso8601Duration - the duration to be added to the instant
    
    Returns:
    
    A new Date or Instant
  - minusSeconds
```
public Object minusSeconds(Object dateOrInstant,
                           long seconds)
```
    Subtracts seconds from an Date or Instant.
    
    Parameters:
    
    dateOrInstant - the basis Date or Instant
    
    seconds - the number of seconds to subtract
    
    Returns:
    
    A new Date or Instant
  - minusMinutes
```
public Object minusMinutes(Object dateOrInstant,
                           long minutes)
```
    Subtracts minutes from an Date or Instant.
    
    Parameters:
    
    dateOrInstant - the basis Date or Instant
    
    minutes - the number of minutes to subtract
    
    Returns:
    
    A new Date or Instant
  - minusHours
```
public Object minusHours(Object dateOrInstant,
                         long hours)
```
    Subtracts hours from an Date or Instant.
    
    Parameters:
    
    dateOrInstant - the basis Date or Instant
    
    hours - the number of hours to subtract
    
    Returns:
    
    A new Date or Instant
  - minusDays
```
public Object minusDays(Object dateOrInstant,
                        long days)
```
    Subtracts hours from an instant.
    
    Parameters:
    
    dateOrInstant - the basis Date or Instant
    
    days - the number of days to subtract
    
    Returns:
    
    A new Date or Instant
  - minusWeeks
```
public Object minusWeeks(Object dateOrInstant,
                         long weeks)
```
    Subtracts weeks to an Date or Instant.
    
    Parameters:
    
    dateOrInstant - the basis Date or Instant
    
    weeks - the number of weeks to subtract
    
    Returns:
    
    A new Date or Instant
  - minusMonths
```
public Object minusMonths(Object dateOrInstant,
                          long months)
```
    Subtracts months from a Date or Instant.
    
    Parameters:
    
    dateOrInstant - the basis Date or Instant
    
    months - the number of months to subtract
    
    Returns:
    
    A new Date or Instant
  - minusYears
```
public Object minusYears(Object dateOrInstant,
                         long years)
```
    Subtracts years to a Date or Instant.
    
    Parameters:
    
    dateOrInstant - the basis Date or Instant
    
    years - the number of years to subtract
    
    Returns:
    
    A new Date or Instant
  - minusDuration
```
public Object minusDuration(Object dateOrInstant,
                            String iso8601Duration)
```
    Subtracts an ISO8601-encoded duration from a Date or Instant. Example: #{flwTimeUtils.minusDuration(now(), 'P1Y')} subtracts a year Example: #{flwTimeUtils.minusDuration(now(), 'P14D')} subtracts 14 days Example: #{flwTimeUtils.minusDuration(now(), 'PT30M10S')} subtracts 30 minutes and ten seconds
    
    Parameters:
    
    dateOrInstant - the basis Date or Instant
    
    iso8601Duration - the duration to be added
    
    Returns:
    
    A new Date or Instant
  - secondsOfDuration
```
public long secondsOfDuration(String iso8601Duration)
```
    Gets the number of seconds in a ISO duration string, e.g. PT60M returns 3600.
    
    Parameters:
    
    iso8601Duration -
    
    Returns:
    
    Number of seconds in the given duration
  - currentDate
```
public Instant currentDate()
```
    Returns the current date at 00:00 AM UTC.
    
    Returns:
    
    An Instant of the current date at 00:00 AM UTC.
  - isBefore
```
public boolean isBefore(Object dateOrInstant,
                        Object otherDateOrInstant)
```
    Checks if the instant is before another Date or Instant.
    
    Parameters:
    
    dateOrInstant - first Date or Instant to compare to
    
    otherDateOrInstant - Date or Instant to which to compare
    
    Returns:
    
    Whether or not the first Date or Instant is before the second Date or Instant
  - isAfter
```
public boolean isAfter(Object dateOrInstant,
                       Object otherDateOrInstant)
```
    Checks if the Date or Instant is after another Date or Instant.
    
    Parameters:
    
    dateOrInstant - first Date or Instant to compare to
    
    otherDateOrInstant - Date or Instant to which to compare
    
    Returns:
    
    Whether or not the first Date or Instant is after the second Date or Instant
  - isBeforeTime
```
public boolean isBeforeTime(Object dateOrInstant,
                            String timeZoneId,
                            int hours,
                            int minutes,
                            int seconds)
```
    Checks if an Date or Instant is before a certain time in a given time zone.
    
    Parameters:
    
    dateOrInstant - Date or Instant to compare the time to
    
    timeZoneId - the time zone of the given instant
    
    hours - hour within the same day
    
    minutes - minutes within the hour
    
    seconds - seconds within the minute
    
    Returns:
    
    Whether or not the given Date or Instant is before the given time in a certain time zone
  - isAfterTime
```
public boolean isAfterTime(Object dateOrInstant,
                           String timeZoneId,
                           int hours,
                           int minutes,
                           int seconds)
```
    Checks if an Date or Instant is after a certain time in a given time zone.
    
    Parameters:
    
    dateOrInstant - Date or Instant to compare the time to
    
    timeZoneId - the time zone of the given instant
    
    hours - hour within the same day
    
    minutes - minutes within the hour
    
    seconds - seconds within the minute
    
    Returns:
    
    Whether or not the given Date or Instant is after the given time in a certain time zone
  - secondsBetweenDates
```
public long secondsBetweenDates(Object firstDateOrInstant,
                                Object secondDateOrInstant)
```
    Returns the number of seconds between two Date or Instant.
    
    Parameters:
    
    firstDateOrInstant - the first Date or Instant
    
    secondDateOrInstant - the second Date or Instant
    
    Returns:
    
    Number of seconds between the two Date or Instant
  - getFieldFromDurationBetweenDates
```
public long getFieldFromDurationBetweenDates(Object firstDateOrInstant,
                                             Object secondDateOrInstant,
                                             String chronoUnitString)
```
    Gets the duration between two Date or Instant and extracts in a certain unit. The following units are supported: Nanos, Micros, Millis, Seconds, Hours, HalfDays, Days, Weeks, Months, Years, Decades, Centuries, Millenia Please note that the number will always be an integer, i.e. the number will always be rounded.
    
    Parameters:
    
    firstDateOrInstant - the first Date or Instant
    
    secondDateOrInstant - the second Date or Instant
    
    chronoUnitString - chrono Unit to be extracted, e.g. 'Seconds' or 'Days'
    
    Returns:
    
    Duration between two Date or Instant in the specific unit.
  - getTimeZoneOffset
```
public long getTimeZoneOffset(Object dateOrInstant,
                              String timeZoneId)
```
    Calculates the number of seconds a specific point in time at a specified time zone is set off from UTC. You have to provide an Date or Instant because, depending on the time of the year, offsets can vary. This is useful to calculate the time in another time zone. Please note that you should never store the result of such calculations since Instants should always be stored in UTC. Example: #{flwTimeUtils.getTimZoneOffset(now(), "Pacific/Honolulu)} calculates the number of seconds between Honolulu and UTC time Example: #{flwTimeUtils.plusSeconds(now(), flwTimeUtils.getTimeZoneOffset(now(), "Europe/Zurich")} returns the current time in Zurich.
    
    Parameters:
    
    dateOrInstant - the date you want to check the offset at
    
    timeZoneId - the time zone
    
    Returns:
    
    The offset in seconds
  - instantFromTimestamp
```
public Instant instantFromTimestamp(long timestamp)
```
    Returns an instant from the number of seconds that have passed since the first of January 1970 (Unix Timestamp).
    
    Parameters:
    
    timestamp -
    
    Returns:
    
    Instant at the specified time stamp.
  - dateFromTimestamp
```
public Date dateFromTimestamp(long timestamp)
```
    Returns a date from the number of seconds that have passed since the first of January 1970 (Unix Timestamp).
    
    Parameters:
    
    timestamp -
    
    Returns:
    
    Date at the specified time stamp.
  - now
```
public Instant now()
```
    Returns the current date and time in UTC.
    
    Returns:
    
    Current date and time

Class FlowableExpressionTimeUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FlowableExpressionTimeUtils

Method Detail

parseInstant

parseInstant

asDate

atTime

atTimeWithTimeZone

atTimeZone

getAvailableTimeZoneIds

getField

isWeekend

fullDateTimeInstant

fullDateTimeDate

plusSeconds

plusMinutes

plusHours

plusDays

plusWeeks

plusMonths

plusYears

plusDuration

minusSeconds

minusMinutes

minusHours

minusDays

minusWeeks

minusMonths

minusYears

minusDuration

secondsOfDuration

currentDate

isBefore

isAfter

isBeforeTime

isAfterTime

secondsBetweenDates

getFieldFromDurationBetweenDates

getTimeZoneOffset

instantFromTimestamp

dateFromTimestamp

now