io.engineblock.activityapi.cyclelog.buffers.cycles

Interface CycleSegment

All Known Implementing Classes:

CycleArray.ArraySegment, InputInterval.Segment

public interface CycleSegment

A segment of cycle numbers to iterate over. Usage of an InputSegment is meant to be stack-local, or at least single threaded, so no precautions are needed to make it thread safe.

Method Summary

Modifier and Type	Method and Description
boolean	isExhausted()
long	nextCycle() The next cycle, which should be a positive number between 0 and Long.MAX_VALUE.
default long[]	nextCycles(int len)
long	peekNextCycle()

Method Detail

nextCycle

long nextCycle()

The next cycle, which should be a positive number between 0 and Long.MAX_VALUE. If a negative value is returned, then the caller should disregard the value and assume that any further input segments will be invalid.

Implementations of this method should not worry about thread safety.

Returns:

a positive and valid long cycle, or a negative indicator of end of input

isExhausted

boolean isExhausted()

Returns:

true if the input can provide no further cycles

nextCycles

default long[] nextCycles(int len)

peekNextCycle

long peekNextCycle()