org.rvpf.base

Class TimeInterval

Object

TimeInterval

All Implemented Interfaces:

Serializable

@Immutable
public final class TimeInterval
extends Object
implements Serializable

Time interval.

A time interval instance represents the time interval between two absolute times. It may be specified as either open or closed at each end.

To be valid, a time interval must not go backward.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeInterval.Builder Time interval builder.
static class	TimeInterval.InvalidIntervalException Invalid interval exception.

Field Summary

Fields

Modifier and Type	Field and Description
static TimeInterval	UNLIMITED Unlimited time interval.

Method Summary

Modifier and Type	Method and Description
TimeInterval	after(DateTime after) Returns a clone with the after time set.
TimeInterval	before(DateTime before) Returns a clone with the before time set.
boolean	contains(DateTime dateTime) Asks if this interval contains a date and time.
boolean	equals(Object other)
Optional<DateTime>	getAfter() Gets the after time.
Optional<DateTime>	getBefore() Gets the before time.
DateTime	getBeginning(boolean closed) Gets the date-time at the beginning of this.
DateTime	getEnd(boolean closed) Gets the date-time at the end of this.
Optional<DateTime>	getNotAfter() Gets not after time.
Optional<DateTime>	getNotBefore() Gets not before time.
int	hashCode()
boolean	isAfter(DateTime dateTime) Asks if this interval is after a date and time.
boolean	isBefore(DateTime dateTime) Asks if this interval is before a date and time.
boolean	isFromBeginningOfTime() Asks if this time interval is from the beginning of time.
boolean	isInstant() Asks if this time interval is an instant.
boolean	isToEndOfTime() Asks if this time interval is to the end of time.
static TimeInterval.Builder	newBuilder() Returns a new builder.
TimeInterval	notAfter(DateTime notAfter) Returns a clone with the end set.
TimeInterval	notBefore(DateTime notBefore) Returns a clone with the beginning set.
String	toString()
TimeInterval	trimmed(TimeInterval limits) Returns a clone of this time interval trimmed to supplied limits.

Methods inherited from class Object

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

Field Detail

UNLIMITED

public static final TimeInterval UNLIMITED

Unlimited time interval.

Method Detail

newBuilder

@Nonnull
 @CheckReturnValue
public static TimeInterval.Builder newBuilder()

Returns a new builder.

Returns:

The new builder.

after

@Nonnull
 @CheckReturnValue
public TimeInterval after(@Nonnull
                                                        DateTime after)

Returns a clone with the after time set.

Parameters:

after - The after time.

Returns:

The clone.

before

@Nonnull
 @CheckReturnValue
public TimeInterval before(@Nonnull
                                                         DateTime before)

Returns a clone with the before time set.

Parameters:

before - The before time.

Returns:

The clone.

contains

@CheckReturnValue
public boolean contains(@Nonnull
                                           DateTime dateTime)

Asks if this interval contains a date and time.

Parameters:

dateTime - The date and time.

Returns:

True if this interval contains the date and time.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

getAfter

@Nonnull
 @CheckReturnValue
public Optional<DateTime> getAfter()

Gets the after time.

Returns:

The after time.

getBefore

@Nonnull
 @CheckReturnValue
public Optional<DateTime> getBefore()

Gets the before time.

Returns:

The before time.

getBeginning

@Nonnull
 @CheckReturnValue
public DateTime getBeginning(boolean closed)

Gets the date-time at the beginning of this.

Parameters:

closed - True for a closed limit.

Returns:

The date-time at the beginning of this.

getEnd

@Nonnull
 @CheckReturnValue
public DateTime getEnd(boolean closed)

Gets the date-time at the end of this.

Parameters:

closed - True for a closed limit.

Returns:

The date-time at the end of this.

getNotAfter

@Nonnull
 @CheckReturnValue
public Optional<DateTime> getNotAfter()

Gets not after time.

Returns:

Not after time.

getNotBefore

@Nonnull
 @CheckReturnValue
public Optional<DateTime> getNotBefore()

Gets not before time.

Returns:

Not before time.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isAfter

@CheckReturnValue
public boolean isAfter(@Nonnull
                                          DateTime dateTime)

Asks if this interval is after a date and time.

Parameters:

dateTime - The date and time.

Returns:

True if this interval is after the date and time.

isBefore

@CheckReturnValue
public boolean isBefore(@Nonnull
                                           DateTime dateTime)

Asks if this interval is before a date and time.

Parameters:

dateTime - The date and time.

Returns:

True if this interval is before the date and time.

isFromBeginningOfTime

@CheckReturnValue
public boolean isFromBeginningOfTime()

Asks if this time interval is from the beginning of time.

Returns:

True if this is from the beginning of time.

isInstant

@CheckReturnValue
public boolean isInstant()

Asks if this time interval is an instant.

Returns:

True if this is an instant in time.

isToEndOfTime

@CheckReturnValue
public boolean isToEndOfTime()

Asks if this time interval is to the end of time.

Returns:

True if this is to the end of time.

notAfter

@Nonnull
 @CheckReturnValue
public TimeInterval notAfter(@Nonnull
                                                           DateTime notAfter)

Returns a clone with the end set.

Parameters:

notAfter - The closed end of the interval.

Returns:

The clone.

notBefore

@Nonnull
 @CheckReturnValue
public TimeInterval notBefore(@Nonnull
                                                            DateTime notBefore)

Returns a clone with the beginning set.

Parameters:

notBefore - The closed beginning of the interval.

Returns:

The clone.

toString

public String toString()

Overrides:

toString in class Object

trimmed

@Nonnull
 @CheckReturnValue
public TimeInterval trimmed(@Nonnull
                                                          TimeInterval limits)

Returns a clone of this time interval trimmed to supplied limits.

Parameters:

limits - The limits.

Returns:

The trimmed time interval.