Class BreakableSpliterator<E>

java.lang.Object

org.soliscode.test.OptionalMethodSupport

org.soliscode.test.breakable.AbstractBreakable

org.soliscode.test.breakable.BreakableSpliterator<E>

Type Parameters:

E - the element type.

All Implemented Interfaces:

Spliterator<E>, Breakable, SupportedMethods

public class BreakableSpliterator<E>
extends AbstractBreakable
implements Spliterator<E>

An Spliterator that can be broken in well-defined ways in order to test collection utilities or testing classes.

Breaks

The breaks that are supported for this class are listed in the description of the method that they impact.

Any breaks that are not listed in this class can be added to an instance of BreakableSpliterator, but will not have any impact on how it functions.

Since:

1.0

Author:

evanbergstrom

See Also:

• Spliterator

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Spliterator

Spliterator.OfDouble, Spliterator.OfInt, Spliterator.OfLong, Spliterator.OfPrimitive<T,T_CONS,T_SPLITR extends Spliterator.OfPrimitive<T,T_CONS,T_SPLITR>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Break	SPLITERATOR_CHARACTERISTICS_ALWAYS_RETURNS_ZERO	The characteristics method always returns zero (0).
static final Break	SPLITERATOR_ESTIMATE_SIZE_ALWAYS_RETURNS_MAX_VALUE	The estimateSize method always returns the max value.
static final Break	SPLITERATOR_ESTIMATE_SIZE_ALWAYS_RETURNS_ZERO	The estimateSize method always returns zero.
static final Break	SPLITERATOR_FOR_EACH_REMAINING_DOES_NOT_CALL_ACTION	The 'forEachRemaining' method on the spliterator does not call the action.
static final Break	SPLITERATOR_GET_COMPARATOR_ALWAYS_RETURNS_NULL	The getComparator method always return null.
static final Break	SPLITERATOR_GET_EXACT_SIZE_IF_KNOWN_ALWAYS_RETURNS_NEGATIVE_ONE	The getExactSizeIfKnown method always returns negative one (-1).
static final Break	SPLITERATOR_HAS_CHARACTERISTIC_ALWAYS_RETURNS_FALSE	The hasCharacteristics method always returns false.
static final Break	SPLITERATOR_HAS_CHARACTERISTIC_ALWAYS_RETURNS_TRUE	The hasCharacteristics method always returns true.
static final Break	SPLITERATOR_IS_ALWAYS_EMPTY	The spliterator always has no elements.
static final Break	SPLITERATOR_SKIPS_FIRST_ELEMENT	The spliterator that skips the first element.
static final Break	SPLITERATOR_TRY_ADVANCE_ALWAYS_RETURNS_FALSE	The 'tryAdvance' method always returns false.
static final Break	SPLITERATOR_TRY_ADVANCE_ALWAYS_RETURNS_TRUE	The 'tryAdvance' method always returns true.
static final Break	SPLITERATOR_TRY_ADVANCE_DOES_NOT_CALL_ACTION	The 'tryAdvance' method on the spliterator does not call the action.
static final Break	SPLITERATOR_TRY_SPLIT_ALWAYS_RETURNS_NULL	The 'trySplit' method on the spliterator always returns null.

Fields inherited from interface java.util.Spliterator

CONCURRENT, DISTINCT, IMMUTABLE, NONNULL, ORDERED, SIZED, SORTED, SUBSIZED

Constructor Summary

Constructors

Constructor	Description
BreakableSpliterator(Spliterator<E> iterator, Collection<Break> breaks, int characteristics)	Constructs a breakable spliterator from a spliterator that will provide the implementation.

Method Summary

Modifier and Type	Method	Description
int	characteristics()	Implements the characteristics method from the Spliterator interface.
long	estimateSize()	Implements the estimateSize method from the Spliterator interface.
void	forEachRemaining(Consumer<? super E> action)	Implements the forEachRemaining method from the Spliterator interface.
Comparator<? super E>	getComparator()
long	getExactSizeIfKnown()	Implements the getExactSizeIfKnown method from the Spliterator interface.
boolean	hasCharacteristics(int characteristics)	Implements the hasCharacteristics method from the Spliterator interface.
boolean	tryAdvance(Consumer<? super E> action)	Implements the tryAdvance method from the Spliterator interface.
Spliterator<E>	trySplit()	Implements the forEachRemaining method from the Spliterator interface.

Methods inherited from class org.soliscode.test.breakable.AbstractBreakable

addBreaks, breaks, hasBreak

Methods inherited from class org.soliscode.test.OptionalMethodSupport

doesNotSupportMethod, supportsMethod, unsupportedMethods

Methods inherited from class java.lang.Object

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

Field Details

SPLITERATOR_IS_ALWAYS_EMPTY

public static final Break SPLITERATOR_IS_ALWAYS_EMPTY

The spliterator always has no elements.

SPLITERATOR_SKIPS_FIRST_ELEMENT

public static final Break SPLITERATOR_SKIPS_FIRST_ELEMENT

The spliterator that skips the first element.

SPLITERATOR_FOR_EACH_REMAINING_DOES_NOT_CALL_ACTION

public static final Break SPLITERATOR_FOR_EACH_REMAINING_DOES_NOT_CALL_ACTION

The 'forEachRemaining' method on the spliterator does not call the action.

See Also:

• forEachRemaining(Consumer)

SPLITERATOR_TRY_SPLIT_ALWAYS_RETURNS_NULL

public static final Break SPLITERATOR_TRY_SPLIT_ALWAYS_RETURNS_NULL

The 'trySplit' method on the spliterator always returns null.

See Also:

• trySplit()

SPLITERATOR_TRY_ADVANCE_DOES_NOT_CALL_ACTION

public static final Break SPLITERATOR_TRY_ADVANCE_DOES_NOT_CALL_ACTION

The 'tryAdvance' method on the spliterator does not call the action.

See Also:

• tryAdvance(Consumer)

SPLITERATOR_TRY_ADVANCE_ALWAYS_RETURNS_TRUE

public static final Break SPLITERATOR_TRY_ADVANCE_ALWAYS_RETURNS_TRUE

The 'tryAdvance' method always returns true.

See Also:

• SPLITERATOR_TRY_ADVANCE_ALWAYS_RETURNS_TRUE,

SPLITERATOR_TRY_ADVANCE_ALWAYS_RETURNS_FALSE

public static final Break SPLITERATOR_TRY_ADVANCE_ALWAYS_RETURNS_FALSE

The 'tryAdvance' method always returns false.

See Also:

• tryAdvance(Consumer)

SPLITERATOR_ESTIMATE_SIZE_ALWAYS_RETURNS_MAX_VALUE

public static final Break SPLITERATOR_ESTIMATE_SIZE_ALWAYS_RETURNS_MAX_VALUE

The estimateSize method always returns the max value.

See Also:

• estimateSize()

SPLITERATOR_ESTIMATE_SIZE_ALWAYS_RETURNS_ZERO

public static final Break SPLITERATOR_ESTIMATE_SIZE_ALWAYS_RETURNS_ZERO

The estimateSize method always returns zero.

See Also:

• estimateSize()

SPLITERATOR_GET_EXACT_SIZE_IF_KNOWN_ALWAYS_RETURNS_NEGATIVE_ONE

public static final Break SPLITERATOR_GET_EXACT_SIZE_IF_KNOWN_ALWAYS_RETURNS_NEGATIVE_ONE

The getExactSizeIfKnown method always returns negative one (-1).

See Also:

• getExactSizeIfKnown()

SPLITERATOR_CHARACTERISTICS_ALWAYS_RETURNS_ZERO

public static final Break SPLITERATOR_CHARACTERISTICS_ALWAYS_RETURNS_ZERO

The characteristics method always returns zero (0).

See Also:

• characteristics()

SPLITERATOR_HAS_CHARACTERISTIC_ALWAYS_RETURNS_TRUE

public static final Break SPLITERATOR_HAS_CHARACTERISTIC_ALWAYS_RETURNS_TRUE

The hasCharacteristics method always returns true.

See Also:

• hasCharacteristics(int)

SPLITERATOR_HAS_CHARACTERISTIC_ALWAYS_RETURNS_FALSE

public static final Break SPLITERATOR_HAS_CHARACTERISTIC_ALWAYS_RETURNS_FALSE

The hasCharacteristics method always returns false.

See Also:

• hasCharacteristics(int)

SPLITERATOR_GET_COMPARATOR_ALWAYS_RETURNS_NULL

public static final Break SPLITERATOR_GET_COMPARATOR_ALWAYS_RETURNS_NULL

The getComparator method always return null.

See Also:

• getComparator()

Constructor Details

BreakableSpliterator

public BreakableSpliterator(Spliterator<E> iterator,
 Collection<Break> breaks,
 int characteristics)

Constructs a breakable spliterator from a spliterator that will provide the implementation.

Parameters:

iterator - The spliterator that will provide the implementation

breaks - The breaks that define how the iterator is broken.

characteristics - A mask that indicates the characteristics of the iterator.

Method Details

forEachRemaining

public void forEachRemaining(Consumer<? super E> action)

Implements the forEachRemaining method from the Spliterator interface.

Breaks

This method can be broken using the following collection breaks:

• SPLITERATOR_FOR_EACH_REMAINING_DOES_NOT_CALL_ACTION

Example

A spliterator that has any of these breaks can be constructed using the iterable builder:

    Spliterator<Integer> iterator = Breakable.iterableOf(1,2,3,4,5)
        .withBreak(SPLITERATOR_FOR_EACH_REMAINING_DOES_NOT_CALL_ACTION)
        .build().spliterator();

Specified by:

forEachRemaining in interface Spliterator<E>

Parameters:

action - The action to run on the remaining elements.

trySplit

public Spliterator<E> trySplit()

Implements the forEachRemaining method from the Spliterator interface.

Breaks

This method can be broken using the following collection breaks:

• SPLITERATOR_TRY_SPLIT_ALWAYS_RETURNS_NULL
• SPLITERATOR_IS_ALWAYS_EMPTY

Example

A spliterator that has any of these breaks can be constructed using the iterable builder:

    Spliterator<Integer> iterator = Breakable.iterableOf(1,2,3,4,5)
        .withBreak(SPLITERATOR_TRY_SPLIT_ALWAYS_RETURNS_NULL)
        .build().spliterator();

Specified by:

trySplit in interface Spliterator<E>

tryAdvance

public boolean tryAdvance(Consumer<? super E> action)

Implements the tryAdvance method from the Spliterator interface.

Breaks

This method can be broken using the following collection breaks:

• SPLITERATOR_IS_ALWAYS_EMPTY
• SPLITERATOR_TRY_ADVANCE_DOES_NOT_CALL_ACTION
• SPLITERATOR_TRY_ADVANCE_ALWAYS_RETURNS_TRUE
• SPLITERATOR_TRY_ADVANCE_ALWAYS_RETURNS_FALSE

Example

A spliterator that has any of these breaks can be constructed using the iterable builder:

    Spliterator<Integer> iterator = Breakable.iterableOf(1,2,3,4,5)
        .withBreak(SPLITERATOR_TRY_ADVANCE_DOES_NOT_CALL_ACTION)
        .build().spliterator();

Specified by:

tryAdvance in interface Spliterator<E>

Parameters:

action - The action to perform on the element

Returns:

false if no remaining elements existed upon entry to this method, else true.

estimateSize

public long estimateSize()

Implements the estimateSize method from the Spliterator interface.

Breaks

This method can be broken using the following collection breaks:

• SPLITERATOR_IS_ALWAYS_EMPTY
• SPLITERATOR_ESTIMATE_SIZE_ALWAYS_RETURNS_MAX_VALUE
• SPLITERATOR_ESTIMATE_SIZE_ALWAYS_RETURNS_ZERO

Example

A spliterator that has any of these breaks can be constructed using the iterable builder:

    Spliterator<Integer> iterator = Breakable.iterableOf(1,2,3,4,5)
        .withBreak(SPLITERATOR_ESTIMATE_SIZE_ALWAYS_RETURNS_MAX_VALUE)
        .build().spliterator();

Specified by:

estimateSize in interface Spliterator<E>

Returns:

the estimated size, or zero if iut is broken, or Long. MAX_VALUE if infinite, unknown, too expensive to compute or broken.

getExactSizeIfKnown

public long getExactSizeIfKnown()

Implements the getExactSizeIfKnown method from the Spliterator interface.

Breaks

This method can be broken using the following collection breaks:

• SPLITERATOR_IS_ALWAYS_EMPTY
• SPLITERATOR_GET_EXACT_SIZE_IF_KNOWN_ALWAYS_RETURNS_NEGATIVE_ONE

Example

A spliterator that has any of these breaks can be constructed using the iterable builder:

    Spliterator<Integer> iterator = Breakable.iterableOf(1,2,3,4,5)
        .withBreak(SPLITERATOR_GET_EXACT_SIZE_IF_KNOWN_ALWAYS_RETURNS_NEGATIVE_ONE)
        .build().spliterator();

Specified by:

getExactSizeIfKnown in interface Spliterator<E>

Returns:

the exact size, if known, else -1, or another value if it is broken.

characteristics

public int characteristics()

Implements the characteristics method from the Spliterator interface.

Breaks

This method can be broken using the following breaks:

• SPLITERATOR_CHARACTERISTICS_ALWAYS_RETURNS_ZERO

Example

A spliterator that has any of these breaks can be constructed using the iterable builder:

    Spliterator<Integer> iterator = Breakable.iterableOf(1,2,3,4,5)
        .withBreak(SPLITERATOR_CHARACTERISTICS_ALWAYS_RETURNS_ZERO)
        .build().spliterator();

Specified by:

characteristics in interface Spliterator<E>

Returns:

a representation of characteristics, or possibly zero if the spliterator is broken.

hasCharacteristics

public boolean hasCharacteristics(int characteristics)

Implements the hasCharacteristics method from the Spliterator interface.

Breaks

This method can be broken using the following collection breaks:

• SPLITERATOR_HAS_CHARACTERISTIC_ALWAYS_RETURNS_TRUE

Example

A spliterator that has any of these breaks can be constructed using the iterable builder:

    Spliterator<Integer> iterator = Breakable.iterableOf(1,2,3,4,5)
        .withBreak(SPLITERATOR_CHARACTERISTICS_ALWAYS_RETURNS_ZERO)
        .build().spliterator();

Specified by:

hasCharacteristics in interface Spliterator<E>

Returns:

a representation of characteristics, or possibly zero if the spliterator is broken.

getComparator

public Comparator<? super E> getComparator()

Specified by:

getComparator in interface Spliterator<E>