org.flexiblepower.time

Class TimeUtil

java.lang.Object

org.flexiblepower.time.TimeUtil

public final class TimeUtil
extends java.lang.Object

This is a utility class for calculations between Date objects and Measurable<Duration> objects.

Field Summary

Fields

Modifier and Type	Field and Description
static Unit<Duration>	MS Represents Milliseconds.
static Measurable<Duration>	ZERO Represents a duration with no length.

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Date	add(java.util.Date startDate, Measurable<Duration> duration) Adds a duration to a date to get another Date object.
static Measurable<Duration>	difference(java.util.Date startDate, java.util.Date endDate) Calculates the difference between 2 dates.
static java.util.Date	subtract(java.util.Date startDate, Measurable<Duration> duration) Subtracts a duration from a date to get another Date object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MS

public static final Unit<Duration> MS

Represents Milliseconds.

ZERO

public static final Measurable<Duration> ZERO

Represents a duration with no length.

Method Detail

add

public static java.util.Date add(java.util.Date startDate,
                 Measurable<Duration> duration)

Adds a duration to a date to get another Date object.

Parameters:

startDate - The starting time

duration - The duration to add

Returns:

A new Date object that represents the time that is duration after the startDate.

Throws:

java.lang.NullPointerException - when any of the parameters is null

subtract

public static java.util.Date subtract(java.util.Date startDate,
                      Measurable<Duration> duration)

Subtracts a duration from a date to get another Date object.

Parameters:

startDate - The starting time

duration - The duration to subtract

Returns:

A new Date object that represents the time that is duration before the startDate.

Throws:

java.lang.NullPointerException - when any of the parameters is null

difference

public static Measurable<Duration> difference(java.util.Date startDate,
                              java.util.Date endDate)

Calculates the difference between 2 dates.

Parameters:

startDate - The starting date

endDate - The ending date

Returns:

A new Measurable object that represents the difference between the 2 dates.

Throws:

java.lang.NullPointerException - when any of the parameters is null