org.rvpf.base.sync

Class StampsSync

Object

Sync.Abstract

StampsSync

All Implemented Interfaces:

Externalizable, Serializable, Sync

@NotThreadSafe
public final class StampsSync
extends Sync.Abstract

Stamps sync.

Instances of this class can be used to prepare store queries on arbitrary time stamps.

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
StampsSync() Constructs an instance.
StampsSync(DateTime[] stamps) Constructs an instance.
StampsSync(DateTime[] stamps, ZoneId zoneId) Constructs an instance.
StampsSync(String[] stampStrings) Constructs an instance.
StampsSync(String[] stamps, ZoneId zoneId) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
Sync	copy() Creates a copy of this.
boolean	equals(Object other)
TimeInterval	getDefaultLimits() Gets the default limits.
Optional<DateTime>	getNextStamp() Gets the next time stamp.
Optional<DateTime>	getPreviousStamp() Gets the previous time stamp.
int	hashCode()
boolean	isInSync() Asks if the current time stamp is in sync.
void	readExternal(ObjectInput input)
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, getFirstStamp, getLastStamp, getLimits, getNextStamp, getNextStamp, getNextStamp, getPreviousStamp, getPreviousStamp, getPreviousStamp, getThisLogger, getZoneId, isBounded, isInSync, iterator, iterator, nextStamp, previousStamp, reverseIterator, reverseIterator, seed, setCurrentStamp, setLimits, setZoneId

Methods inherited from class Object

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

Constructor Detail

StampsSync

public StampsSync()

Constructs an instance.

Needed for dynamic instantiation.

StampsSync

public StampsSync(DateTime[] stamps)

Constructs an instance.

Parameters:

stamps - The time stamps.

StampsSync

public StampsSync(String[] stampStrings)

Constructs an instance.

Parameters:

stampStrings - Time stamp strings (ISO 8601).

StampsSync

public StampsSync(@Nonnull
                  DateTime[] stamps,
                  @Nonnull
                  ZoneId zoneId)

Constructs an instance.

Parameters:

stamps - The time stamps.

zoneId - The zone id.

StampsSync

public StampsSync(@Nonnull
                  String[] stamps,
                  @Nonnull
                  ZoneId zoneId)

Constructs an instance.

Parameters:

stamps - The time stamps (ISO 8601).

zoneId - The zone id.

Method Detail

copy

public Sync copy()

Creates a copy of this.

Returns:

The copy.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

getDefaultLimits

public TimeInterval getDefaultLimits()

Gets the default limits.

Specified by:

getDefaultLimits in interface Sync

Overrides:

getDefaultLimits in class Sync.Abstract

Returns:

The default limits.

getNextStamp

public Optional<DateTime> getNextStamp()

Gets the next time stamp.

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).

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

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