Class AbortTupleSequence

  • All Implemented Interfaces:
    Tuple, TupleSequence, uk.ac.starlink.util.Splittable<TupleSequence>, uk.ac.starlink.util.SplittableSequence<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 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()
        Specified by:
        next in interface uk.ac.starlink.util.SplittableSequence<TupleSequence>
      • splittableSize

        public long splittableSize()
        Specified by:
        splittableSize in interface uk.ac.starlink.util.Splittable<TupleSequence>
      • isAborted

        public boolean isAborted()
        Indicates whether the abort condition has been detected.
        Returns:
        true iff the abort condition has been detected