org.rvpf.base

Class TimeInterval.Builder

Object

TimeInterval.Builder

All Implemented Interfaces:

Externalizable, Serializable

Enclosing class:

TimeInterval

@NotThreadSafe
public static final class TimeInterval.Builder
extends Object
implements Externalizable

Time interval builder.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TimeInterval	build() Builds a time interval.
TimeInterval.Builder	clear() Clears this builder.
TimeInterval.Builder	copyFrom(TimeInterval otherInterval) Copies the values from an other time interval.
static TimeInterval	fromString(String intervalString) Returns a time interval from a string representation.
Optional<DateTime>	getAfter() Gets the after time.
Optional<DateTime>	getBefore() Gets the before time.
boolean	isInstant() Asks if this time interval is an instant.
boolean	isValid() Asks if this time interval is valid.
void	readExternal(ObjectInput input)
TimeInterval.Builder	setAfter(DateTime after) Sets the after time.
TimeInterval.Builder	setAt(DateTime at) Sets an instant.
TimeInterval.Builder	setBefore(DateTime before) Sets the before time.
TimeInterval.Builder	setNotAfter(DateTime notAfter) Sets the not after time.
TimeInterval.Builder	setNotBefore(DateTime notBefore) Sets the not before time.
String	toString()
TimeInterval.Builder	trim(TimeInterval limits) Trims an interval to supplied limits.
void	writeExternal(ObjectOutput output)

Methods inherited from class Object

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

Constructor Detail

Builder

public Builder()

Method Detail

fromString

@Nonnull
 @CheckReturnValue
public static TimeInterval fromString(@Nonnull
                                                                    String intervalString)

Returns a time interval from a string representation.

Parameters:

intervalString - The interval string.

Returns:

The time interval.

build

@Nonnull
 @CheckReturnValue
public TimeInterval build()

Builds a time interval.

Returns:

The time interval.

clear

@Nonnull
public TimeInterval.Builder clear()

Clears this builder.

Returns:

This.

copyFrom

@Nonnull
public TimeInterval.Builder copyFrom(@Nonnull
                                               TimeInterval otherInterval)

Copies the values from an other time interval.

Parameters:

otherInterval - The other time interval.

Returns:

This.

getAfter

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

Gets the after time.

Returns:

The after time (may be empty).

getBefore

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

Gets the before time.

Returns:

The before time (may be empty).

isInstant

@CheckReturnValue
public boolean isInstant()

Asks if this time interval is an instant.

Returns:

True if this is an instant in time.

isValid

@CheckReturnValue
public boolean isValid()

Asks if this time interval is valid.

To be valid, the interval must either represent an instant or go forward in time.

Returns:

True if it is valid.

readExternal

public void readExternal(@Nonnull
                         ObjectInput input)
                  throws IOException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

setAfter

@Nonnull
public TimeInterval.Builder setAfter(@Nonnull
                                               DateTime after)

Sets the after time.

Parameters:

after - The after time.

Returns:

This.

setAt

@Nonnull
public TimeInterval.Builder setAt(@Nonnull
                                            DateTime at)

Sets an instant.

Parameters:

at - The instant.

Returns:

This.

setBefore

@Nonnull
public TimeInterval.Builder setBefore(@Nonnull
                                                DateTime before)

Sets the before time.

Parameters:

before - The before time.

Returns:

This.

setNotAfter

@Nonnull
public TimeInterval.Builder setNotAfter(@Nonnull
                                                  DateTime notAfter)

Sets the not after time.

Parameters:

notAfter - The not after time.

Returns:

This.

setNotBefore

@Nonnull
public TimeInterval.Builder setNotBefore(@Nonnull
                                                   DateTime notBefore)

Sets the not before time.

Parameters:

notBefore - The not before time.

Returns:

This.

toString

public String toString()

Overrides:

toString in class Object

trim

@Nonnull
public TimeInterval.Builder trim(@Nonnull
                                           TimeInterval limits)

Trims an interval to supplied limits.

Parameters:

limits - The limits.

Returns:

This.

writeExternal

public void writeExternal(@Nonnull
                          ObjectOutput output)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException