Class BreakableIterator<E>

java.lang.Object

org.soliscode.test.OptionalMethodSupport

org.soliscode.test.breakable.AbstractBreakable

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

Type Parameters:

E - the element type.

All Implemented Interfaces:

Iterator<E>, Breakable, SupportedMethods

public class BreakableIterator<E>
extends AbstractBreakable
implements Iterator<E>

An iterator 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 BreakableIterator, but will not have any impact on how it functions.

Since:

1.0

Author:

evanbergstrom

See Also:

• Iterator

Field Summary

Fields

Modifier and Type	Field	Description
static final Break	ITERATOR_FOR_EACH_REMAINING_DOES_NOT_CALL_ACTION	The iterator 'forEachRemaining' does not call the action
static final Break	ITERATOR_FOR_EACH_REMAINING_THROWS_WRONG_EXCEPTION_FOR_NULL_ARGUMENT	The iterator 'forEachRemaining' throws the wrong exception for a null argument.
static final Break	ITERATOR_HAS_NEXT_ALWAYS_RETURNS_FALSE	The iterator hasNext method will always return a false.
static final Break	ITERATOR_HAS_NEXT_ALWAYS_RETURNS_TRUE	The iterator hasNext method will always return a true.
static final Break	ITERATOR_HAS_NEXT_RETURNS_OPPOSITE_VALUE	The iterator hasNext method will always return the opposite value
static final Break	ITERATOR_IS_ALWAYS_EMPTY	The iterator will always have no elements
static final Break	ITERATOR_NEXT_ALWAYS_RETURNS_NULL	The iterator next method will always return null
static final Break	ITERATOR_NEXT_THROWS_WRONG_EXCEPTION	The iterator next method will always return null
static final Break	ITERATOR_REMOVE_DOES_NOT_REMOVE_ELEMENT	The iterator 'remove' method does not remove the element at the current iterator position.
static final Break	ITERATOR_REMOVE_THROWS_WRONG_EXCEPTION_FOR_ILLEGAL_STATE	The iterator 'remove' method throws the wrong exception for an illegal state
static final Break	ITERATOR_REMOVE_THROWS_WRONG_EXCEPTION_IF_NOT_SUPPORTED	The iterator 'remove' method throws the wrong exception nif it is not supported.
static final Break	ITERATOR_SKIPS_FIRST_ELEMENT	The iterator will skip the first element.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	forEachRemaining(Consumer<? super E> action)	Implements the forEachRemaining method from the Iterator interface.
boolean	hasNext()	Implements the hasNext method from the Iterator interface.
E	next()	Implements the next method from the Iterator interface.
void	remove()	Implements the remove method from the Iterator 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

ITERATOR_IS_ALWAYS_EMPTY

public static final Break ITERATOR_IS_ALWAYS_EMPTY

The iterator will always have no elements

ITERATOR_SKIPS_FIRST_ELEMENT

public static final Break ITERATOR_SKIPS_FIRST_ELEMENT

The iterator will skip the first element.

ITERATOR_HAS_NEXT_ALWAYS_RETURNS_TRUE

public static final Break ITERATOR_HAS_NEXT_ALWAYS_RETURNS_TRUE

The iterator hasNext method will always return a true.

See Also:

• hasNext()

ITERATOR_HAS_NEXT_ALWAYS_RETURNS_FALSE

public static final Break ITERATOR_HAS_NEXT_ALWAYS_RETURNS_FALSE

The iterator hasNext method will always return a false.

See Also:

• hasNext()

ITERATOR_HAS_NEXT_RETURNS_OPPOSITE_VALUE

public static final Break ITERATOR_HAS_NEXT_RETURNS_OPPOSITE_VALUE

The iterator hasNext method will always return the opposite value

See Also:

• hasNext()

ITERATOR_NEXT_ALWAYS_RETURNS_NULL

public static final Break ITERATOR_NEXT_ALWAYS_RETURNS_NULL

The iterator next method will always return null

See Also:

• next()

ITERATOR_NEXT_THROWS_WRONG_EXCEPTION

public static final Break ITERATOR_NEXT_THROWS_WRONG_EXCEPTION

The iterator next method will always return null

See Also:

• next()

ITERATOR_REMOVE_DOES_NOT_REMOVE_ELEMENT

public static final Break ITERATOR_REMOVE_DOES_NOT_REMOVE_ELEMENT

The iterator 'remove' method does not remove the element at the current iterator position.

See Also:

• remove()

ITERATOR_REMOVE_THROWS_WRONG_EXCEPTION_FOR_ILLEGAL_STATE

public static final Break ITERATOR_REMOVE_THROWS_WRONG_EXCEPTION_FOR_ILLEGAL_STATE

The iterator 'remove' method throws the wrong exception for an illegal state

See Also:

• remove()

ITERATOR_REMOVE_THROWS_WRONG_EXCEPTION_IF_NOT_SUPPORTED

public static final Break ITERATOR_REMOVE_THROWS_WRONG_EXCEPTION_IF_NOT_SUPPORTED

The iterator 'remove' method throws the wrong exception nif it is not supported.

See Also:

• remove()

ITERATOR_FOR_EACH_REMAINING_DOES_NOT_CALL_ACTION

public static final Break ITERATOR_FOR_EACH_REMAINING_DOES_NOT_CALL_ACTION

The iterator 'forEachRemaining' does not call the action

See Also:

• forEachRemaining(Consumer)

ITERATOR_FOR_EACH_REMAINING_THROWS_WRONG_EXCEPTION_FOR_NULL_ARGUMENT

public static final Break ITERATOR_FOR_EACH_REMAINING_THROWS_WRONG_EXCEPTION_FOR_NULL_ARGUMENT

The iterator 'forEachRemaining' throws the wrong exception for a null argument.

See Also:

• forEachRemaining(Consumer)

Constructor Details

BreakableIterator

public BreakableIterator(Iterator<E> iterator,
 Collection<Break> breaks,
 int characteristics)

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

Parameters:

iterator - The iterator 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

hasNext

@Contract(pure=true)
public boolean hasNext()

Implements the hasNext method from the Iterator interface.

Breaks

This method can be broken using the following collection breaks:

• ITERATOR_IS_ALWAYS_EMPTY
• ITERATOR_HAS_NEXT_ALWAYS_RETURNS_TRUE
• ITERATOR_HAS_NEXT_ALWAYS_RETURNS_FALSE
• ITERATOR_HAS_NEXT_RETURNS_OPPOSITE_VALUE

Example

A iterator that has any of these breaks can be constructed using the BreakableIterator builder:

    Iterator<Integer> iterator = Breakable.iterableOf(1,2,3,4,5)
        .withBreak(ITERATOR_HAS_NEXT_ALWAYS_RETURNS_TRUE)
        .build().iterator();

Specified by:

hasNext in interface Iterator<E>

Returns:

'true' or 'false' depending on the state of the iterator and the breaks.

See Also:

• Iterator.hasNext()

next

@Contract(mutates="this")
public E next()

Implements the next method from the Iterator interface.

#Breaks This method can be broken using the following collection breaks:

• ITERATOR_NEXT_ALWAYS_RETURNS_NULL
• ITERATOR_NEXT_ALWAYS_RETURNS_NULL

A iterator that has any of these breaks can be constructed using the BreakableIterator builder:

    Iterator<Integer> iterator = Breakable.iterableOf(1,2,3,4,5)
        .withBreak(ITERATOR_NEXT_ALWAYS_RETURNS_NULL)
        .build().iterator();

Specified by:

next in interface Iterator<E>

Returns:

The next element or null if there sare no more elements or if the iterator is broken.

Throws:

NoSuchElementException - if the iteration has no more elements

See Also:

• Iterator.next()

remove

public void remove()

Implements the remove method from the Iterator interface.

#Breaks This method can be broken using the following collection breaks:

• ITERATOR_REMOVE_DOES_NOT_REMOVE_ELEMENT
• ITERATOR_REMOVE_THROWS_WRONG_EXCEPTION_IF_NOT_SUPPORTED
• ITERATOR_REMOVE_THROWS_WRONG_EXCEPTION_FOR_ILLEGAL_STATE

A iterator that has any of these breaks can be constructed using the BreakableIterator builder:

    Iterator<Integer> iterator = Breakable.iterableOf(1,2,3,4,5)
        .withBreak(ITERATOR_REMOVE_DOES_NOT_REMOVE_ELEMENT)
        .build().iterator();

Specified by:

remove in interface Iterator<E>

Throws:

UnsupportedOperationException - if the remove operation is not supported by this iterator

IllegalStateException - if the next method has not yet been called, or the remove method has already been called after the last call to the next method.

See Also:

• Iterator.remove()

forEachRemaining

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

Implements the forEachRemaining method from the Iterator interface.

#Breaks This method can be broken using the following iterable breaks:

• ITERATOR_FOR_EACH_REMAINING_DOES_NOT_CALL_ACTION
• ITERATOR_FOR_EACH_REMAINING_THROWS_WRONG_EXCEPTION_FOR_NULL_ARGUMENT

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

    Iterable<Integer> iterable = Breakable.iterableOf(1,2,3,4,5)
        .withBreak(ITERATOR_FOR_EACH_REMAINING_DOES_NOT_CALL_ACTION)
        .build();

Specified by:

forEachRemaining in interface Iterator<E>

Parameters:

action - The action to run on the remaining elements.

Throws:

NullPointerException - if the specified action is null