Class PieceIterator

java.lang.Object

VASSAL.counters.PieceIterator

public class PieceIterator
extends Object

An iterator for GamePieces. Takes an optional PieceFilter to extract GamePiece instances from an Enumeration or Iterator.

Field Summary

Fields

Modifier and Type	Field	Description
static final Predicate<GamePiece>	VISIBLE

Constructor Summary

Constructors

Constructor	Description
PieceIterator(Enumeration<T> e, PieceFilter f)	Deprecated, for removal: This API element is subject to removal in a future version.
PieceIterator(Iterator<? extends GamePiece> i)
PieceIterator(Iterator<? extends GamePiece> i, PieceFilter f)

Method Summary

Modifier and Type	Method	Description
boolean	hasMoreElements()
GamePiece	nextPiece()
static <T extends GamePiece> PieceIterator	visible(Enumeration<T> e)	Deprecated, for removal: This API element is subject to removal in a future version.
static <T extends GamePiece> PieceIterator	visible(Iterator<T> i)

Methods inherited from class java.lang.Object

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

Field Details

VISIBLE

public static final Predicate<GamePiece> VISIBLE

Constructor Details

PieceIterator

public PieceIterator(Iterator<? extends GamePiece> i)

PieceIterator

public PieceIterator(Iterator<? extends GamePiece> i,
 PieceFilter f)

PieceIterator

@Deprecated(since="2021-12-01",
            forRemoval=true)
public PieceIterator(Enumeration<T> e,
 PieceFilter f)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

nextPiece

public GamePiece nextPiece()

hasMoreElements

public boolean hasMoreElements()

visible

public static <T extends GamePiece> PieceIterator visible(Iterator<T> i)

visible

@Deprecated(since="2021-12-01",
            forRemoval=true)
public static <T extends GamePiece> PieceIterator visible(Enumeration<T> e)

Deprecated, for removal: This API element is subject to removal in a future version.