org.rvpf.base.sync

Class Sync.Abstract

Object

Sync.Abstract

All Implemented Interfaces:

Externalizable, Serializable, Sync

Direct Known Subclasses:

CrontabSync, ElapsedSync, NullSync, StampsSync

Enclosing interface:

Sync

public abstract static class Sync.Abstract
extends Object
implements Sync, Externalizable

Abstract.

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

Modifier	Constructor and Description
protected	Abstract() Constructs an instance.
protected	Abstract(Sync.Abstract other) Constructs an instance from an other.
protected	Abstract(ZoneId zoneId) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
protected void	checkNotFrozen() Checks that the sync is not frozen.
protected void	freeze() Freezes.
DateTime	getCurrentStamp() Gets the current stamp.
TimeInterval	getDefaultLimits() Gets the default limits.
DateTime	getFirstStamp() Gets the first stamp.
DateTime	getLastStamp() Gets the last stamp.
TimeInterval	getLimits() Gets the limits.
Optional<DateTime>	getNextStamp(DateTime stamp) Gets the next time stamp.
Optional<DateTime>	getNextStamp(DateTime stamp, int intervals) Gets the next time stamp separated by a number of intervals.
Optional<DateTime>	getNextStamp(int intervals) Gets the next time stamp separated by a number of intervals.
Optional<DateTime>	getPreviousStamp(DateTime stamp) Gets the previous time stamp.
Optional<DateTime>	getPreviousStamp(DateTime stamp, int intervals) Gets the previous time stamp separated by a number of intervals.
Optional<DateTime>	getPreviousStamp(int intervals) Gets the previous time stamp separated by a number of intervals.
protected Logger	getThisLogger() Gets the logger.
protected ZoneId	getZoneId() Gets the zone id.
boolean	isBounded() Returns true if the limits are inside BoT to EoT.
boolean	isInSync(DateTime stamp) Asks if the reference time stamp is in sync.
ListIterator<DateTime>	iterator() Returns an iterator.
ListIterator<DateTime>	iterator(DateTime stamp) Returns an iterator.
protected Optional<DateTime>	nextStamp() Returns the next stamp.
protected Optional<DateTime>	previousStamp() Returns the previous stamp.
void	readExternal(ObjectInput input)
ListIterator<DateTime>	reverseIterator() Returns a reverse iterator.
ListIterator<DateTime>	reverseIterator(DateTime stamp) Returns a reverse iterator.
void	seed(DateTime stamp) Seeds the time stamp.
protected void	setCurrentStamp(DateTime stamp, int direction) Sets the current stamp.
void	setLimits(TimeInterval limits) Sets the limits.
boolean	setUp(Params params) Sets up this sync.
protected void	setZoneId(ZoneId zoneId) Sets the zone id.
void	tearDown() Tears down what has been set up.
String	toString()
void	writeExternal(ObjectOutput output)

Methods inherited from class Object

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

Methods inherited from interface Sync

copy, getNextStamp, getPreviousStamp, isInSync

Constructor Detail

Abstract

protected Abstract()

Constructs an instance.

Abstract

protected Abstract(@Nonnull
                   Sync.Abstract other)

Constructs an instance from an other.

Parameters:

other - The other instance.

Abstract

protected Abstract(@Nonnull
                   ZoneId zoneId)

Constructs an instance.

Parameters:

zoneId - The zone id.

Method Detail

getCurrentStamp

public final DateTime getCurrentStamp()

Gets the current stamp.

Specified by:

getCurrentStamp in interface Sync

Returns:

The current stamp.

getDefaultLimits

public TimeInterval getDefaultLimits()

Gets the default limits.

Specified by:

getDefaultLimits in interface Sync

Returns:

The default limits.

getFirstStamp

public DateTime getFirstStamp()

Gets the first stamp.

Specified by:

getFirstStamp in interface Sync

Returns:

The first stamp.

getLastStamp

public DateTime getLastStamp()

Gets the last stamp.

Specified by:

getLastStamp in interface Sync

Returns:

The last stamp.

getLimits

public final TimeInterval getLimits()

Gets the limits.

Specified by:

getLimits in interface Sync

Returns:

The limits.

getNextStamp

public final Optional<DateTime> getNextStamp(DateTime stamp)

Gets the next time stamp.

Specified by:

getNextStamp in interface Sync

Parameters:

stamp - The reference 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

Parameters:

intervals - A number of intervals.

Returns:

The next time stamp (empty if none).

getNextStamp

public final Optional<DateTime> getNextStamp(DateTime stamp,
                                             int intervals)

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

Specified by:

getNextStamp in interface Sync

Parameters:

stamp - The reference time stamp.

intervals - A number of intervals.

Returns:

The next time stamp (empty if none).

getPreviousStamp

public final Optional<DateTime> getPreviousStamp(DateTime stamp)

Gets the previous time stamp.

Specified by:

getPreviousStamp in interface Sync

Parameters:

stamp - The reference 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

Parameters:

intervals - A number of intervals.

Returns:

The next time stamp (empty if none).

getPreviousStamp

public Optional<DateTime> getPreviousStamp(DateTime stamp,
                                           int intervals)

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

Specified by:

getPreviousStamp in interface Sync

Parameters:

stamp - The reference time stamp.

intervals - A number of intervals.

Returns:

The previous time stamp (empty if none).

isBounded

public final boolean isBounded()

Returns true if the limits are inside BoT to EoT.

Specified by:

isBounded in interface Sync

Returns:

True if the limits are inside BoT to EoT.

isInSync

public final boolean isInSync(DateTime stamp)

Asks if the reference time stamp is in sync.

Specified by:

isInSync in interface Sync

Parameters:

stamp - The reference time stamp.

Returns:

True when in sync.

iterator

public ListIterator<DateTime> iterator()

Returns an iterator.

Specified by:

iterator in interface Sync

Returns:

The iterator.

iterator

public ListIterator<DateTime> iterator(DateTime stamp)

Returns an iterator.

Specified by:

iterator in interface Sync

Parameters:

stamp - The initial stamp.

Returns:

The iterator.

readExternal

public void readExternal(ObjectInput input)
                  throws IOException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

reverseIterator

public ListIterator<DateTime> reverseIterator()

Returns a reverse iterator.

Specified by:

reverseIterator in interface Sync

Returns:

The iterator.

reverseIterator

public ListIterator<DateTime> reverseIterator(DateTime stamp)

Returns a reverse iterator.

Specified by:

reverseIterator in interface Sync

Parameters:

stamp - The initial stamp.

Returns:

The iterator.

seed

public final void seed(DateTime stamp)

Seeds the time stamp.

Specified by:

seed in interface Sync

Parameters:

stamp - The time stamp.

setLimits

public void setLimits(TimeInterval limits)

Sets the limits.

Specified by:

setLimits in interface Sync

Parameters:

limits - The limits.

setUp

@CheckReturnValue
public boolean setUp(@Nonnull
                                        Params params)

Sets up this sync.

Parameters:

params - The sync params.

Returns:

True on success.

tearDown

public void tearDown()

Tears down what has been set up.

toString

public String toString()

Overrides:

toString in class Object

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

checkNotFrozen

protected final void checkNotFrozen()

Checks that the sync is not frozen.

freeze

protected final void freeze()

Freezes.

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger.

Returns:

The logger.

getZoneId

@Nonnull
 @CheckReturnValue
protected final ZoneId getZoneId()

Gets the zone id.

Returns:

The time id.

nextStamp

@Nonnull
 @CheckReturnValue
protected final Optional<DateTime> nextStamp()

Returns the next stamp.

Returns:

The next stamp (empty if after limit ends).

previousStamp

@Nonnull
 @CheckReturnValue
protected final Optional<DateTime> previousStamp()

Returns the previous stamp.

Returns:

The previous stamp (empty if before limit begins).

setCurrentStamp

protected final void setCurrentStamp(@Nonnull
                                     DateTime stamp,
                                     int direction)

Sets the current stamp.

Parameters:

stamp - The stamp.

direction - The direction of the change (0 for don't care).

setZoneId

protected final void setZoneId(@Nonnull
                               ZoneId zoneId)

Sets the zone id.

Parameters:

zoneId - The zone id.