squidpony.squidgrid.iterator

Class SquidIterators.VerticalUp

java.lang.Object

squidpony.squidgrid.iterator.SquidIterators.VerticalUp

All Implemented Interfaces:

java.util.Iterator<Coord>, SquidIterator

Enclosing class:

SquidIterators

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

An iterator to iterate from a starting position (exclusive) and going up. This iterator cycles when reaching the map's bound, but it iterates at most once on a cell, i.e. it does at most one roll over a column of the map.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	height The grid's height
protected Coord	prev
protected int	startx The starting X-coordinate
protected int	starty The starting Y-coordinate
protected int	width The grid's width

Constructor Summary

Constructors

Constructor and Description
VerticalUp(Coord start, int width, int height) An iterator to iterate vertically, starting AFTER start.
VerticalUp(int startx, int starty, int width, int height) An iterator to iterate vertically, starting AFTER (startx, starty).

Method Summary

Modifier and Type	Method and Description
protected Coord	findNext()
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

startx

protected final int startx

The starting X-coordinate

starty

protected final int starty

The starting Y-coordinate

prev

protected Coord prev

width

protected final int width

The grid's width

height

protected final int height

The grid's height

Constructor Detail

VerticalUp

public VerticalUp(int startx,
                  int starty,
                  int width,
                  int height)

An iterator to iterate vertically, starting AFTER (startx, starty). This iterates cycles when it reaches the map's bound, but it iterates at most once on a cell, i.e. it does at most one roll over a column of the map.

Parameters:

startx - The starting X-coordinate.

starty - The starting vertical-coordinate.

width - The map's width.

height - The map's height.

VerticalUp

public VerticalUp(Coord start,
                  int width,
                  int height)

An iterator to iterate vertically, starting AFTER start. This iterates cycles when it reaches the map's bound, but it iterates at most once on a cell, i.e. it does at most one roll over a column of the map.

Parameters:

start - The starting coordinate.

width - The map's width.

height - The map'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>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<Coord>

findNext

protected Coord findNext()