Package io.github.projectunified.blockutil.iterator

Class LinearPositionIterator

java.lang.Object

io.github.projectunified.blockutil.core.iterator.AbstractPositionIterator

io.github.projectunified.blockutil.core.iterator.BasePositionIterator

io.github.projectunified.blockutil.iterator.LinearPositionIterator

All Implemented Interfaces:

PositionIterator, Iterator<Position>

public class LinearPositionIterator
extends BasePositionIterator

The PositionIterator that iterates in a linear way

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LinearPositionIterator.LinearCoordinate	The linear subject

Field Summary

Fields

Modifier and Type	Field	Description
static final LinearPositionIterator.LinearCoordinate	X_COORDINATE	A linear subject for the x-axis
static final LinearPositionIterator.LinearCoordinate	Y_COORDINATE	A linear subject for the y-axis
static final LinearPositionIterator.LinearCoordinate	Z_COORDINATE	A linear subject for the z-axis

Fields inherited from class io.github.projectunified.blockutil.core.iterator.AbstractPositionIterator

box

Constructor Summary

Constructors

Constructor	Description
LinearPositionIterator(BlockBox box)	Create a new iterator
LinearPositionIterator(BlockBox box, LinearPositionIterator.LinearCoordinate... coordinates)	Create a new iterator

Method Summary

Modifier and Type	Method	Description
Position	getContinue(Position current)	Get the next Position
boolean	hasContinue(Position current)	Check if there is a next Position
Position	initial()	Get the initial Position

Methods inherited from class io.github.projectunified.blockutil.core.iterator.BasePositionIterator

getCurrent, hasNext, next, reset

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, remove

Field Details

X_COORDINATE

public static final LinearPositionIterator.LinearCoordinate X_COORDINATE

A linear subject for the x-axis

Y_COORDINATE

public static final LinearPositionIterator.LinearCoordinate Y_COORDINATE

A linear subject for the y-axis

Z_COORDINATE

public static final LinearPositionIterator.LinearCoordinate Z_COORDINATE

A linear subject for the z-axis

Constructor Details

LinearPositionIterator

public LinearPositionIterator(BlockBox box,
 LinearPositionIterator.LinearCoordinate... coordinates)

Create a new iterator

Parameters:

box - the box

coordinates - the linear subjects

LinearPositionIterator

public LinearPositionIterator(BlockBox box)

Create a new iterator

Parameters:

box - the box

Method Details

initial

public Position initial()

Description copied from class: BasePositionIterator

Get the initial Position

Specified by:

initial in class BasePositionIterator

Returns:

the initial position

getContinue

public Position getContinue(Position current)
                     throws NoSuchElementException

Description copied from class: BasePositionIterator

Get the next Position

Specified by:

getContinue in class BasePositionIterator

Parameters:

current - the current position

Returns:

the next position

Throws:

NoSuchElementException - if there is no next position

hasContinue

public boolean hasContinue(Position current)

Description copied from class: BasePositionIterator

Check if there is a next Position

Specified by:

hasContinue in class BasePositionIterator

Parameters:

current - the current position

Returns:

true if there is a next position