com.github.dm.jrt.util

Class TimeDuration

java.lang.Object

com.github.dm.jrt.util.Time

com.github.dm.jrt.util.TimeDuration

public class TimeDuration
extends Time

Utility class for handling a time duration in different time units.

Created by davide-maestroni on 09/09/2014.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TimeDuration.Check Interface defining a check to be performed.

Field Summary

Fields

Modifier and Type	Field and Description
static TimeDuration	INFINITY Time duration instance representing the infinity.
static TimeDuration	ZERO Time duration instance representing the zero.

Fields inherited from class com.github.dm.jrt.util.Time

HOURS_IN_DAY, MINUTES_IN_DAY, MINUTES_IN_HOUR, SECONDS_IN_DAY, SECONDS_IN_HOUR, SECONDS_IN_MINUTE, time, unit

Method Summary

Methods

Modifier and Type	Method and Description
static TimeDuration	days(long days) Creates and returns an object representing the specified number of days.
TimeDuration	daysTime() Converts this duration in days.
static TimeDuration	fromUnit(long time, TimeUnit unit) Creates and returns an object representing the specified time value in the specified time unit.
static TimeDuration	hours(long hours) Creates and returns an object representing the specified number of hours.
TimeDuration	hoursTime() Converts this duration in hours.
boolean	isInfinity() Checks if this duration represents the infinity.
void	join(Thread target) Performs a Thread.join() using this duration as timeout.
static TimeDuration	micros(long micros) Creates and returns an object representing the specified number of microseconds.
TimeDuration	microsTime() Converts this duration in microseconds.
static TimeDuration	millis(long millis) Creates and returns an object representing the specified number of milliseconds.
TimeDuration	millisTime() Converts this duration in milliseconds.
TimeDuration	minus(Time time) Returns a new instance whose time value is decremented by the specified one. Note that the unit of the returned time will match the one with the highest precision. Note also that, if the resulting time is negative, the value will be clipped to 0.
static TimeDuration	minutes(long minutes) Creates and returns an object representing the specified number of minutes.
TimeDuration	minutesTime() Converts this duration in minutes.
static TimeDuration	nanos(long nanos) Creates and returns an object representing the specified number of nanoseconds.
TimeDuration	nanosTime() Converts this duration in nanoseconds.
TimeDuration	plus(Time time) Returns a new instance whose time value is incremented by the specified one. Note that the unit of the returned time will match the one with the highest precision. Note also that, if the resulting time is negative, the value will be clipped to 0.
static TimeDuration	seconds(long seconds) Creates and returns an object representing the specified number of seconds.
TimeDuration	secondsTime() Converts this duration in seconds.
void	sleep() Performs a Thread.sleep(long, int) using this duration as timeout.
void	sleepAtLeast() Performs a Thread.sleep(long, int) using this duration as timeout, ensuring that the sleep time is respected even if spurious wake ups happen in the while.
boolean	sleepSinceMillis(long milliTime) Performs a Thread.sleep(long, int) as if started from the specified system time in milliseconds, by using this duration as timeout.
boolean	sleepSinceNanos(long nanoTime) Performs a Thread.sleep(long, int) as if started from the specified high precision system time in nanoseconds, by using this duration as timeout.
static TimeDuration	timeSinceMillis(long milliTime) Creates and returns an object representing the time range between now and a time in the past.
static TimeDuration	timeSinceNanos(long nanoTime) Creates and returns an object representing the time range between now and a time in the past.
static TimeDuration	timeUntilMillis(long milliTime) Creates and returns an object representing the time range between now and a time in the future. If the specified is in the past, a ZERO duration will be returned.
static TimeDuration	timeUntilNanos(long nanoTime) Creates and returns an object representing the time range between now and a time in the future. If the specified is in the past, a ZERO duration will be returned.
void	wait(Object target) Performs an Object.wait() using this duration as timeout.
boolean	waitSinceMillis(Object target, long milliTime) Performs an Object.wait() as if started from the specified system time in milliseconds, by using this duration as timeout.
boolean	waitSinceNanos(Object target, long nanoTime) Performs an Object.wait() as if started from the specified high precision system time in nanoseconds, by using this duration as timeout.
boolean	waitTrue(Object target, TimeDuration.Check check) Waits for the specified check to be true by performing an Object.wait() and using this duration as timeout.

Methods inherited from class com.github.dm.jrt.util.Time

current, currentNano, equals, hashCode, isZero, to, toDays, toHours, toMicros, toMillis, toMinutes, toNanos, toSeconds, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

INFINITY

public static final TimeDuration INFINITY

Time duration instance representing the infinity.

ZERO

public static final TimeDuration ZERO

Time duration instance representing the zero.

Method Detail

days

@NotNull
public static TimeDuration days(long days)

Creates and returns an object representing the specified number of days.

Parameters:

days - the number of days.

Returns:

the time instance.

Throws:

IllegalArgumentException - if the specified duration is negative.

fromUnit

@NotNull
public static TimeDuration fromUnit(long time,
                            @NotNull
                            TimeUnit unit)

Creates and returns an object representing the specified time value in the specified time unit.

Parameters:

time - the time value.

unit - the time unit.

Returns:

the time instance.

Throws:

IllegalArgumentException - if the specified duration is negative.

hours

@NotNull
public static TimeDuration hours(long hours)

Creates and returns an object representing the specified number of hours.

Parameters:

hours - the number of hours

Returns:

the time instance.

Throws:

IllegalArgumentException - if the specified duration is negative.

micros

@NotNull
public static TimeDuration micros(long micros)

Creates and returns an object representing the specified number of microseconds.

Parameters:

micros - the number of microseconds.

Returns:

the time duration instance.

Throws:

IllegalArgumentException - if the specified duration is negative.

millis

@NotNull
public static TimeDuration millis(long millis)

Creates and returns an object representing the specified number of milliseconds.

Parameters:

millis - the number of milliseconds.

Returns:

the time duration instance.

Throws:

IllegalArgumentException - if the specified duration is negative.

minutes

@NotNull
public static TimeDuration minutes(long minutes)

Creates and returns an object representing the specified number of minutes.

Parameters:

minutes - the number of minutes.

Returns:

the time duration instance.

Throws:

IllegalArgumentException - if the specified duration is negative.

nanos

@NotNull
public static TimeDuration nanos(long nanos)

Creates and returns an object representing the specified number of nanoseconds.

Parameters:

nanos - the number of nanoseconds.

Returns:

the time duration instance.

Throws:

IllegalArgumentException - if the specified duration is negative.

seconds

@NotNull
public static TimeDuration seconds(long seconds)

Creates and returns an object representing the specified number of seconds.

Parameters:

seconds - the number of seconds.

Returns:

the time duration instance.

Throws:

IllegalArgumentException - if the specified duration is negative.

timeSinceMillis

@NotNull
public static TimeDuration timeSinceMillis(long milliTime)

Creates and returns an object representing the time range between now and a time in the past.
If the specified is in the future, a ZERO duration will be returned.

Parameters:

milliTime - the system time in milliseconds.

Returns:

the time duration instance.

See Also:

System.currentTimeMillis()

timeSinceNanos

@NotNull
public static TimeDuration timeSinceNanos(long nanoTime)

Creates and returns an object representing the time range between now and a time in the past.
If the specified is in the future, a ZERO duration will be returned.

Parameters:

nanoTime - the high precision system time in nanoseconds.

Returns:

the time duration instance.

See Also:

System.nanoTime()

timeUntilMillis

@NotNull
public static TimeDuration timeUntilMillis(long milliTime)

Creates and returns an object representing the time range between now and a time in the future.
If the specified is in the past, a ZERO duration will be returned.

Parameters:

milliTime - the system time in milliseconds.

Returns:

the time duration instance.

See Also:

System.currentTimeMillis()

timeUntilNanos

@NotNull
public static TimeDuration timeUntilNanos(long nanoTime)

Creates and returns an object representing the time range between now and a time in the future.
If the specified is in the past, a ZERO duration will be returned.

Parameters:

nanoTime - the high precision system time in nanoseconds.

Returns:

the time duration instance.

See Also:

System.nanoTime()

daysTime

@NotNull
public TimeDuration daysTime()

Converts this duration in days.

Overrides:

daysTime in class Time

Returns:

the time duration instance.

hoursTime

@NotNull
public TimeDuration hoursTime()

Converts this duration in hours.

Overrides:

hoursTime in class Time

Returns:

the time duration instance.

microsTime

@NotNull
public TimeDuration microsTime()

Converts this duration in microseconds.

Overrides:

microsTime in class Time

Returns:

the time duration instance.

millisTime

@NotNull
public TimeDuration millisTime()

Converts this duration in milliseconds.

Overrides:

millisTime in class Time

Returns:

the time duration instance.

minus

@NotNull
public TimeDuration minus(@NotNull
                         Time time)

Returns a new instance whose time value is decremented by the specified one.
Note that the unit of the returned time will match the one with the highest precision.
Note also that, if the resulting time is negative, the value will be clipped to 0.

Overrides:

minus in class Time

Parameters:

time - the time to subtract.

Returns:

the time duration instance.

minutesTime

@NotNull
public TimeDuration minutesTime()

Converts this duration in minutes.

Overrides:

minutesTime in class Time

Returns:

the time duration instance.

nanosTime

@NotNull
public TimeDuration nanosTime()

Converts this duration in nanoseconds.

Overrides:

nanosTime in class Time

Returns:

the time duration instance.

plus

@NotNull
public TimeDuration plus(@NotNull
                        Time time)

Returns a new instance whose time value is incremented by the specified one.
Note that the unit of the returned time will match the one with the highest precision.
Note also that, if the resulting time is negative, the value will be clipped to 0.

Overrides:

plus in class Time

Parameters:

time - the time to add.

Returns:

the time duration instance.

secondsTime

@NotNull
public TimeDuration secondsTime()

Converts this duration in seconds.

Overrides:

secondsTime in class Time

Returns:

the time duration instance.

isInfinity

public boolean isInfinity()

Checks if this duration represents the infinity.

Returns:

whether this duration is infinite.

join

public void join(@NotNull
        Thread target)
          throws InterruptedException

Performs a Thread.join() using this duration as timeout.

Parameters:

target - the target thread.

Throws:

InterruptedException - if the current thread is interrupted.

sleep

public void sleep()
           throws InterruptedException

Performs a Thread.sleep(long, int) using this duration as timeout.

Throws:

InterruptedException - if the current thread is interrupted.

sleepAtLeast

public void sleepAtLeast()
                  throws InterruptedException

Performs a Thread.sleep(long, int) using this duration as timeout, ensuring that the sleep time is respected even if spurious wake ups happen in the while.

Throws:

InterruptedException - if the current thread is interrupted.

sleepSinceMillis

public boolean sleepSinceMillis(long milliTime)
                         throws InterruptedException

Performs a Thread.sleep(long, int) as if started from the specified system time in milliseconds, by using this duration as timeout.

Parameters:

milliTime - the starting system time in milliseconds.

Returns:

whether the sleep happened at all.

Throws:

IllegalStateException - if this duration overflows the maximum sleep time.

InterruptedException - if the current thread is interrupted.

See Also:

System.currentTimeMillis()

sleepSinceNanos

public boolean sleepSinceNanos(long nanoTime)
                        throws InterruptedException

Performs a Thread.sleep(long, int) as if started from the specified high precision system time in nanoseconds, by using this duration as timeout.

Parameters:

nanoTime - the starting system time in nanoseconds.

Returns:

whether the sleep happened at all.

Throws:

IllegalStateException - if this duration overflows the maximum sleep time.

InterruptedException - if the current thread is interrupted.

See Also:

System.nanoTime()

wait

public void wait(@NotNull
        Object target)
          throws InterruptedException

Performs an Object.wait() using this duration as timeout.

Parameters:

target - the target object.

Throws:

InterruptedException - if the current thread is interrupted.

waitSinceMillis

public boolean waitSinceMillis(@NotNull
                      Object target,
                      long milliTime)
                        throws InterruptedException

Performs an Object.wait() as if started from the specified system time in milliseconds, by using this duration as timeout.

Parameters:

target - the target object.

milliTime - the starting system time in milliseconds.

Returns:

whether the wait happened at all.

Throws:

InterruptedException - if the current thread is interrupted.

See Also:

System.currentTimeMillis()

waitSinceNanos

public boolean waitSinceNanos(@NotNull
                     Object target,
                     long nanoTime)
                       throws InterruptedException

Performs an Object.wait() as if started from the specified high precision system time in nanoseconds, by using this duration as timeout.

Parameters:

target - the target object.

nanoTime - the starting system time in nanoseconds.

Returns:

whether the wait happened at all.

Throws:

InterruptedException - if the current thread is interrupted.

See Also:

System.nanoTime()

waitTrue

public boolean waitTrue(@NotNull
               Object target,
               @NotNull
               TimeDuration.Check check)
                 throws InterruptedException

Waits for the specified check to be true by performing an Object.wait() and using this duration as timeout.

Parameters:

target - the target object.

check - the check to verify.

Returns:

whether the check became true before the timeout elapsed.

Throws:

InterruptedException - if the current thread is interrupted.