uk.ac.starlink.ttools.plot2.data

Class AbortTupleSequence

java.lang.Object

uk.ac.starlink.ttools.plot2.data.WrapperTuple

uk.ac.starlink.ttools.plot2.data.AbortTupleSequence

All Implemented Interfaces:

Tuple, TupleSequence, Sequence, Splittable<TupleSequence>

public class AbortTupleSequence
extends WrapperTuple
implements TupleSequence

Wrapping TupleSequence that tries to give up when a condition becomes true.

Since:

12 Aug 2019

Author:

Mark Taylor

Constructor Summary

Constructors

Constructor and Description
AbortTupleSequence(TupleSequence base, java.util.function.BooleanSupplier abortCondition) Constructor with checking period of 1 (every element).
AbortTupleSequence(TupleSequence base, java.util.function.BooleanSupplier abortCondition, int checkPeriod) Constructor with specified checking period.

Method Summary

Modifier and Type	Method and Description
boolean	isAborted() Indicates whether the abort condition has been detected.
boolean	next() Advances to the next entry.
AbortTupleSequence	split() Attempts to partition this object into two halves, ideally of similar size.
long	splittableSize() Provides an estimate of the number of processable items in this object.

Methods inherited from class uk.ac.starlink.ttools.plot2.data.WrapperTuple

getBooleanValue, getDoubleValue, getIntValue, getLongValue, getObjectValue, getRowIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.starlink.ttools.plot2.data.Tuple

getBooleanValue, getDoubleValue, getIntValue, getLongValue, getObjectValue, getRowIndex

Constructor Detail

AbortTupleSequence

public AbortTupleSequence(TupleSequence base,
                          java.util.function.BooleanSupplier abortCondition)

Constructor with checking period of 1 (every element).

Parameters:

base - base sequence

abortCondition - condition on which the stream should stop

AbortTupleSequence

public AbortTupleSequence(TupleSequence base,
                          java.util.function.BooleanSupplier abortCondition,
                          int checkPeriod)

Constructor with specified checking period.

Parameters:

base - base sequence

abortCondition - condition on which the stream should stop

checkPeriod - approximate frequency of checking the condition

Method Detail

next

public boolean next()

Description copied from interface: TupleSequence

Advances to the next entry. No exception is thrown.

Specified by:

next in interface TupleSequence

Specified by:

next in interface Sequence

Returns:

true iff the current sequence element has data

split

public AbortTupleSequence split()

Description copied from interface: Splittable

Attempts to partition this object into two halves, ideally of similar size. If a non-null value is returned, then the content previously contained by this object is now split between this object and the returned object. If for any reason a split is not carried out, null is returned.

Following a successful call, the two parts may be processed in different threads.

Specified by:

split in interface Splittable<TupleSequence>

Returns:

other half of this splittable, or null

See Also:

Spliterator.trySplit()

splittableSize

public long splittableSize()

Description copied from interface: Splittable

Provides an estimate of the number of processable items in this object. A processable item is not a well-defined quantity, but it should generally be something that can be processed fast. For instance, if this object represents a collection of collections, the value that should be returned is the total number of elements rather than the number of collections.

If no estimate for the size is available, a negative value should be returned.

Specified by:

splittableSize in interface Splittable<TupleSequence>

Returns:

approximate size, or negative value if not known

isAborted

public boolean isAborted()

Indicates whether the abort condition has been detected.

Returns:

true iff the abort condition has been detected