org.cthul.fixsure

Interface SequenceLength

All Known Subinterfaces:

BiSequence<T,U>, FlSequence<T>, FlValues<T>, Sequence<T>, Values<T>

All Known Implementing Classes:

AbstractValues, AnonymousSequence, BiSequence.Anonymous, BoundedSequence, ConsecutiveIntegersSequence, ConstantValue, EagerFetcher.EagerCombinedValues, EagerValues, EmptySequence, ItemsSequence, ItemsSequence.FromArray, ItemsSequence.FromCollection, ItemsSequence.FromRAList, LazyFetcher.LazyCombinedValues, LazyValues, RoundRobinSequence

public interface SequenceLength

Describes the length of a Sequence.

Field Summary

Fields

Modifier and Type	Field and Description
static long	L_NEGATIVE_INDICES
static long	L_UNBOUNDED
static SequenceLength	NEGATIVE_INDICES
static SequenceLength	UNBOUNDED

Method Summary

Modifier and Type	Method and Description
static boolean	isInRange(long index, SequenceLength length) Checks whether an index is in range.
default boolean	isUnbounded() Indicates whether every positive long is accepted.
long	length() Number of elements that can be accessed through Sequence.value(long); negative if sequence is unbounded or allows negative indices.
static SequenceLength	min(SequenceLength a, SequenceLength b)
default boolean	negativeIndices() Indicates whether negative indices are accepted.
static long	toLong(SequenceLength length)

Field Detail

L_UNBOUNDED

static final long L_UNBOUNDED

See Also:

Constant Field Values

L_NEGATIVE_INDICES

static final long L_NEGATIVE_INDICES

See Also:

Constant Field Values

UNBOUNDED

static final SequenceLength UNBOUNDED

NEGATIVE_INDICES

static final SequenceLength NEGATIVE_INDICES

Method Detail

length

long length()

Number of elements that can be accessed through Sequence.value(long); negative if sequence is unbounded or allows negative indices.

Returns:

length

isUnbounded

default boolean isUnbounded()

Indicates whether every positive long is accepted.

Returns:

true if unbounded

negativeIndices

default boolean negativeIndices()

Indicates whether negative indices are accepted. Only if unbounded.

Returns:

true if negative indices are supported.

isInRange

static boolean isInRange(long index,
                         SequenceLength length)

Checks whether an index is in range.

Parameters:

index -

length -

Returns:

true if index is in range

toLong

static long toLong(SequenceLength length)

min

static SequenceLength min(SequenceLength a,
                          SequenceLength b)