squidpony.squidgrid.iterator

Class SquidIterators.BottomLeftToTopRight

java.lang.Object

squidpony.squidgrid.iterator.SquidIterators.BottomLeftToTopRight

All Implemented Interfaces:

java.util.Iterator<Coord>, SquidIterator

Enclosing class:

SquidIterators

public static class SquidIterators.BottomLeftToTopRight
extends java.lang.Object
implements SquidIterator

Iterator that starts from the bottom left element of the grid, to the top right.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	height
protected Coord	previous The point whose character was returned by the previous call to next(), or null if none.
protected int	width

Constructor Summary

Constructors

Constructor and Description
BottomLeftToTopRight(int width, int height) A fresh iterator.

Method Summary

Modifier and Type	Method and Description
Coord	above()
protected boolean	gridIsEmpty()
boolean	hasAbove()
boolean	hasNext()
Coord	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

width

protected final int width

height

protected final int height

previous

protected Coord previous

The point whose character was returned by the previous call to next(), or null if none.

Constructor Detail

BottomLeftToTopRight

public BottomLeftToTopRight(int width,
                            int height)

A fresh iterator.

Parameters:

width - The grid's width.

height - The grid's height.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<Coord>

next

public Coord next()

Specified by:

next in interface java.util.Iterator<Coord>

hasAbove

public boolean hasAbove()

Returns:

Whether above() would return an element (i.e. not throw an exception).

above

public Coord above()

Returns:

The point above the last point returned by next().

Throws:

java.lang.IllegalStateException - If next() wasn't called before.

java.util.NoSuchElementException - If there's no point above the last point returned by next().

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<Coord>

gridIsEmpty

protected boolean gridIsEmpty()