README.md

Clock

System Clock Abstractions & Joda DateTime providers.

Installation

Clock requires Java 8+ to run.

<dependency>
    <groupId>com.deere.isg</groupId>
    <artifactId>clock</artifactId>
    <version>3.1.0</version>
</dependency>

Module support for Java 9 and later

 requires com.deere.isg.clock;

Usage

Getting the current date-time in UTC

   DateTime now = Clock.now();
   Long nowAsMillies = Clock.milliseconds();
   DateTime theUnixEpoch = Clock.epoch(); // -> 1970-01-01:00:00:00

Freezing the clock

Many times in tests you might want to set the system clock to a specific time or simply stop it from progressing. You can do this with freeze. Note that because the clock is static (like the real clock), you must unfreeze it in your teardown.

   Clock.freeze(2011,09,28,4,20); // by a full date-time
   Clock.freeze(2011,09,28); // by just the date
   Clock.freeze(420); // by millies
   Clock.freeze(new DateTime()); // by a specific datetime instance
   Clock.freeze(); //Just stops the clock at the current datetime.
   Clock.freeze(new YourOwnClock()); // define time on your own terms

   Clock.clear() // unfreezes the clock and returns it to system clock progression.

Testing Locally

This builds with Maven 3.6.1 and Java 11.

mvn clean verify

Contributing

Please see the Contribution Guidelines.