ome.smuggler.core.types

Class FutureTimepoint

java.lang.Object

util.object.AbstractWrapper<T>

util.object.Wrapper<java.time.Duration>

ome.smuggler.core.types.FutureTimepoint

All Implemented Interfaces:

java.util.function.Supplier<java.time.Duration>

public class FutureTimepoint
extends util.object.Wrapper<java.time.Duration>

A time point in the future with respect to the time at which it was instantiated.

Field Summary

Fields inherited from class util.object.Wrapper

wrappedValue

Constructor Summary

Constructors

Constructor and Description
FutureTimepoint(java.time.Duration timeSpanFromNow) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	isStillInTheFuture() Is this time point still in the future? An instance of this class is always instantiated with a future time point, but the passing of time will eventually make the initial time point in the past.
static FutureTimepoint	now() Constructs the minimum value admissible for a FutureTimepoint instance which is the current time point.

Methods inherited from class util.object.Wrapper

get

Methods inherited from class util.object.AbstractWrapper

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FutureTimepoint

public FutureTimepoint(java.time.Duration timeSpanFromNow)

Creates a new instance.

Parameters:

timeSpanFromNow - an amount of time to add to the current time to get a time point in the future.

Throws:

java.lang.NullPointerException - if the argument is null.

java.lang.IllegalArgumentException - if the argument is a negative duration.

Method Detail

now

public static FutureTimepoint now()

Constructs the minimum value admissible for a FutureTimepoint instance which is the current time point. of FutureTimepoint.

Returns:

the current time point.

isStillInTheFuture

public boolean isStillInTheFuture()

Is this time point still in the future? An instance of this class is always instantiated with a future time point, but the passing of time will eventually make the initial time point in the past. This method tests for this condition.

Returns:

true for yes, false for no.