Class TimeProvider

java.lang.Object
org.frankframework.util.TimeProvider
public class TimeProvider extends Object
This class provides a way to get current time, but also control time in unit tests.

  • Method Details

    • now

      public static Instant now()
      Get the current system time as Instant.

    • nowAsMillis

      public static long nowAsMillis()
      Get the current system time as clock millis (equivalent to System.currentTimeMillis()).

    • nowAsZonedDateTime

      public static ZonedDateTime nowAsZonedDateTime()
      Get the current system time as ZonedDateTime

    • nowAsLocalDateTime

      public static LocalDateTime nowAsLocalDateTime()
      Get the current system time as LocalDateTime

    • nowAsDate

      public static Date nowAsDate()
      Get the current system time as a legacy Date.

    • setClock

      public static void setClock(@NonNull Clock clock)
      ONLY FOR UNIT TESTING! Set a clock to use. Typically this is for testing, when you want to use a more specialized Clock to set a specific time or behaviour than can be done by setting a clock with a fixed point in time.
      Parameters:
      clock - Clock to use.

    • getClock

      public static Clock getClock()
      Get the Clock currently being used. This clock can be used to get the current time, or as a base-clock to create other specialized clocks for testing, which is the reason to make it accessible.

    • setTime

      public static void setTime(long millis)
      ONLY FOR UNIT TESTING! Set the clock to a fixed date-time from the milliseconds since 1-1-1970 passed in.
      Parameters:
      millis - Time in epoch-milliseconds to which to set the clock.

    • setTime

      public static void setTime(LocalDateTime localDateTime)
      ONLY FOR UNIT TESTING! Set the clock to a fixed date-time from the local date-time passed in.
      Parameters:
      localDateTime - Time to which to set the clock.

    • setTime

      public static void setTime(ZonedDateTime zonedDateTime)
      ONLY FOR UNIT TESTING! Set the clock to a fixed date-time from the date-time invalid input: '&' timezone passed in.
      Parameters:
      zonedDateTime - The time to which to set the clock.

    • resetClock

      public static void resetClock()
      ONLY FOR UNIT TESTING! Resets the clock to the default System UTC clock. This should be used in the test-teardown method of unit tests when the unit tests have set the clock to a none-default clock.