org.rvpf.base.sync

Interface Sync

All Superinterfaces:

Serializable

All Known Implementing Classes:

CrontabSync, ElapsedSync, NullSync, ReverseSync, StampsSync, Sync.Abstract

public interface Sync
extends Serializable

Sync.

This interface is implemented by objects able to synthesize synchronization timestamps.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Sync.Abstract Abstract.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CRONTAB_PARAM Specifies a schedule in the format of an extended crontab entry.
static String	ELAPSED_PARAM Elapsed parameter.
static String	OFFSET_PARAM Offset parameter.
static String	STAMP_PARAM Specifies a schedule with time stamps.
static String	TIME_ZONE_PARAM Specifies a time zone.

Method Summary

Modifier and Type	Method and Description
Sync	copy() Creates a copy of this.
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() Gets the next time stamp.
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() Gets the previous time stamp.
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.
boolean	isBounded() Returns true if the limits are inside BoT to EoT.
boolean	isInSync() Asks if the current time stamp is in sync.
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.
ListIterator<DateTime>	reverseIterator() Returns a reverse iterator.
ListIterator<DateTime>	reverseIterator(DateTime stamp) Returns a reverse iterator.
void	seed(DateTime stamp) Seeds the time stamp.
void	setLimits(TimeInterval limits) Sets the limits.

Field Detail

CRONTAB_PARAM

static final String CRONTAB_PARAM

Specifies a schedule in the format of an extended crontab entry.

See Also:

Constant Field Values

ELAPSED_PARAM

static final String ELAPSED_PARAM

Elapsed parameter.

See Also:

Constant Field Values

OFFSET_PARAM

static final String OFFSET_PARAM

Offset parameter.

See Also:

Constant Field Values

STAMP_PARAM

static final String STAMP_PARAM

Specifies a schedule with time stamps.

See Also:

Constant Field Values

TIME_ZONE_PARAM

static final String TIME_ZONE_PARAM

Specifies a time zone.

See Also:

Constant Field Values

Method Detail

copy

@Nonnull
 @CheckReturnValue
Sync copy()

Creates a copy of this.

Returns:

The copy.

getCurrentStamp

@Nonnull
 @CheckReturnValue
DateTime getCurrentStamp()

Gets the current stamp.

Returns:

The current stamp.

getDefaultLimits

@Nonnull
 @CheckReturnValue
TimeInterval getDefaultLimits()

Gets the default limits.

Returns:

The default limits.

getFirstStamp

@Nonnull
 @CheckReturnValue
DateTime getFirstStamp()

Gets the first stamp.

Returns:

The first stamp.

getLastStamp

@Nonnull
 @CheckReturnValue
DateTime getLastStamp()

Gets the last stamp.

Returns:

The last stamp.

getLimits

@Nonnull
 @CheckReturnValue
TimeInterval getLimits()

Gets the limits.

Returns:

The limits.

getNextStamp

@Nonnull
 @CheckReturnValue
Optional<DateTime> getNextStamp()

Gets the next time stamp.

Returns:

The next time stamp (empty if none).

getNextStamp

@Nonnull
 @CheckReturnValue
Optional<DateTime> getNextStamp(@Nonnull
                                                              DateTime stamp)

Gets the next time stamp.

Parameters:

stamp - The reference time stamp.

Returns:

The next time stamp (empty if none).

getNextStamp

@Nonnull
 @CheckReturnValue
Optional<DateTime> getNextStamp(int intervals)

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

Parameters:

intervals - A number of intervals.

Returns:

The next time stamp (empty if none).

getNextStamp

@Nonnull
 @CheckReturnValue
Optional<DateTime> getNextStamp(@Nonnull
                                                              DateTime stamp,
                                                              int intervals)

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

Parameters:

stamp - The reference time stamp.

intervals - A number of intervals.

Returns:

The next time stamp (empty if none).

getPreviousStamp

@Nonnull
 @CheckReturnValue
Optional<DateTime> getPreviousStamp()

Gets the previous time stamp.

Returns:

The previous time stamp (empty if none).

getPreviousStamp

@Nonnull
 @CheckReturnValue
Optional<DateTime> getPreviousStamp(@Nonnull
                                                                  DateTime stamp)

Gets the previous time stamp.

Parameters:

stamp - The reference time stamp.

Returns:

The previous time stamp (empty if none).

getPreviousStamp

@Nonnull
 @CheckReturnValue
Optional<DateTime> getPreviousStamp(int intervals)

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

Parameters:

intervals - A number of intervals.

Returns:

The next time stamp (empty if none).

getPreviousStamp

@Nonnull
 @CheckReturnValue
Optional<DateTime> getPreviousStamp(@Nonnull
                                                                  DateTime stamp,
                                                                  int intervals)

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

Parameters:

stamp - The reference time stamp.

intervals - A number of intervals.

Returns:

The previous time stamp (empty if none).

isBounded

@CheckReturnValue
boolean isBounded()

Returns true if the limits are inside BoT to EoT.

Returns:

True if the limits are inside BoT to EoT.

isInSync

@CheckReturnValue
boolean isInSync()

Asks if the current time stamp is in sync.

Returns:

True when in sync.

isInSync

@CheckReturnValue
boolean isInSync(@Nonnull
                                    DateTime stamp)

Asks if the reference time stamp is in sync.

Parameters:

stamp - The reference time stamp.

Returns:

True when in sync.

iterator

@Nonnull
 @CheckReturnValue
ListIterator<DateTime> iterator()

Returns an iterator.

Returns:

The iterator.

iterator

@Nonnull
 @CheckReturnValue
ListIterator<DateTime> iterator(@Nonnull
                                                              DateTime stamp)

Returns an iterator.

Parameters:

stamp - The initial stamp.

Returns:

The iterator.

reverseIterator

@Nonnull
 @CheckReturnValue
ListIterator<DateTime> reverseIterator()

Returns a reverse iterator.

Returns:

The iterator.

reverseIterator

@Nonnull
 @CheckReturnValue
ListIterator<DateTime> reverseIterator(@Nonnull
                                                                     DateTime stamp)

Returns a reverse iterator.

Parameters:

stamp - The initial stamp.

Returns:

The iterator.

seed

void seed(@Nonnull
          DateTime stamp)

Seeds the time stamp.

Parameters:

stamp - The time stamp.

setLimits

void setLimits(@Nonnull
               TimeInterval limits)

Sets the limits.

Parameters:

limits - The limits.