org.rvpf.base.sync

Class ElapsedSync

Object

Sync.Abstract

ElapsedSync

All Implemented Interfaces:

Externalizable, Serializable, Sync

@NotThreadSafe
public final class ElapsedSync
extends Sync.Abstract

Elapsed sync.

Instances of this class can be used to prepare store queries on a fixed interval starting from an arbitrary time stamp.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface Sync

Sync.Abstract

Field Summary

Fields inherited from interface Sync

CRONTAB_PARAM, ELAPSED_PARAM, OFFSET_PARAM, STAMP_PARAM, TIME_ZONE_PARAM

Constructor Summary

Constructors

Constructor and Description
ElapsedSync() Constructs an instance.
ElapsedSync(ElapsedTime elapsed, Optional<ElapsedTime> offset) Constructs an instance.
ElapsedSync(String elapsed, Optional<String> offset) Constructs an instance.
ElapsedSync(ZoneId zoneId, ElapsedTime elapsed, Optional<ElapsedTime> offset) Constructs an instance.
ElapsedSync(ZoneId zoneId, String elapsed, Optional<String> offset) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
Sync	copy() Creates a copy of this.
boolean	equals(Object object)
Optional<DateTime>	getNextStamp() Gets the next time stamp.
Optional<DateTime>	getNextStamp(int intervals) Gets the next time stamp separated by a number of intervals.
Optional<DateTime>	getPreviousStamp() Gets the previous time stamp.
Optional<DateTime>	getPreviousStamp(int intervals) Gets the previous time stamp separated by a number of intervals.
int	hashCode()
boolean	isInSync() Asks if the current time stamp is in sync.
void	readExternal(ObjectInput input)
void	setLimits(TimeInterval limits) Sets the limits.
boolean	setUp(Params params) Sets up this sync.
void	tearDown() Tears down what has been set up.
String	toString()
void	writeExternal(ObjectOutput output)

Methods inherited from class Sync.Abstract

checkNotFrozen, freeze, getCurrentStamp, getDefaultLimits, getFirstStamp, getLastStamp, getLimits, getNextStamp, getNextStamp, getPreviousStamp, getPreviousStamp, getThisLogger, getZoneId, isBounded, isInSync, iterator, iterator, nextStamp, previousStamp, reverseIterator, reverseIterator, seed, setCurrentStamp, setZoneId

Methods inherited from class Object

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

Constructor Detail

ElapsedSync

public ElapsedSync()

Constructs an instance.

Needed for dynamic instantiation.

ElapsedSync

public ElapsedSync(@Nonnull
                   ElapsedTime elapsed,
                   @Nonnull
                   Optional<ElapsedTime> offset)

Constructs an instance.

Parameters:

elapsed - An elapsed time.

offset - An optional time offset.

ElapsedSync

public ElapsedSync(@Nonnull
                   String elapsed,
                   @Nonnull
                   Optional<String> offset)

Constructs an instance.

Parameters:

elapsed - An elapsed time representation.

offset - An optional time offset representation.

ElapsedSync

public ElapsedSync(@Nonnull
                   ZoneId zoneId,
                   @Nonnull
                   ElapsedTime elapsed,
                   @Nonnull
                   Optional<ElapsedTime> offset)

Constructs an instance.

Parameters:

zoneId - The zone id.

elapsed - An elapsed time.

offset - An optional time offset.

ElapsedSync

public ElapsedSync(@Nonnull
                   ZoneId zoneId,
                   @Nonnull
                   String elapsed,
                   @Nonnull
                   Optional<String> offset)

Constructs an instance.

Parameters:

zoneId - The zone id.

elapsed - An elapsed time representation.

offset - A time offset representation.

Method Detail

copy

public Sync copy()

Creates a copy of this.

Returns:

The copy.

equals

public boolean equals(Object object)

Overrides:

equals in class Object

getNextStamp

public Optional<DateTime> getNextStamp()

Gets the next time stamp.

Returns:

The next time stamp (empty if none).

getNextStamp

public Optional<DateTime> getNextStamp(int intervals)

Gets the next time stamp separated by a number of intervals.

Specified by:

getNextStamp in interface Sync

Overrides:

getNextStamp in class Sync.Abstract

Parameters:

intervals - A number of intervals.

Returns:

The next time stamp (empty if none).

getPreviousStamp

public Optional<DateTime> getPreviousStamp()

Gets the previous time stamp.

Returns:

The previous time stamp (empty if none).

getPreviousStamp

public Optional<DateTime> getPreviousStamp(int intervals)

Gets the previous time stamp separated by a number of intervals.

Specified by:

getPreviousStamp in interface Sync

Overrides:

getPreviousStamp in class Sync.Abstract

Parameters:

intervals - A number of intervals.

Returns:

The next time stamp (empty if none).

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isInSync

public boolean isInSync()

Asks if the current time stamp is in sync.

Returns:

True when in sync.

readExternal

public void readExternal(ObjectInput input)
                  throws IOException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class Sync.Abstract

Throws:

IOException

setLimits

public void setLimits(TimeInterval limits)

Sets the limits.

Specified by:

setLimits in interface Sync

Overrides:

setLimits in class Sync.Abstract

Parameters:

limits - The limits.

setUp

public boolean setUp(Params params)

Sets up this sync.

Overrides:

setUp in class Sync.Abstract

Parameters:

params - The sync params.

Returns:

True on success.

tearDown

public void tearDown()

Tears down what has been set up.

Overrides:

tearDown in class Sync.Abstract

toString

public String toString()

Overrides:

toString in class Sync.Abstract

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class Sync.Abstract

Throws:

IOException