org.jaitools.imageutils.iterator
Enum AbstractSimpleIterator.Order

java.lang.Object
  extended by java.lang.Enum<AbstractSimpleIterator.Order>
      extended by org.jaitools.imageutils.iterator.AbstractSimpleIterator.Order
All Implemented Interfaces:
Serializable, Comparable<AbstractSimpleIterator.Order>
Enclosing class:
AbstractSimpleIterator

public static enum AbstractSimpleIterator.Order
extends Enum<AbstractSimpleIterator.Order>

Constants defining the visiting order that the iterator will follow when moved with the next() method. Choices are:


Enum Constant Summary
IMAGE_X_Y
          The iterator will move by X (pixel) then Y (line) across the whole image.
TILE_X_Y
          The iterator will move by X (pixel) then Y (line) within each tile of the image in turn.
 
Method Summary
static AbstractSimpleIterator.Order valueOf(String name)
          Returns the enum constant of this type with the specified name.
static AbstractSimpleIterator.Order[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

IMAGE_X_Y

public static final AbstractSimpleIterator.Order IMAGE_X_Y
The iterator will move by X (pixel) then Y (line) across the whole image.


TILE_X_Y

public static final AbstractSimpleIterator.Order TILE_X_Y
The iterator will move by X (pixel) then Y (line) within each tile of the image in turn. The tiles are visited in X (tile grid column) then Y (tile grid row) order. This movement order is most efficient when dealing with large images because it minimizes tile-swapping in memory.

Method Detail

values

public static AbstractSimpleIterator.Order[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (AbstractSimpleIterator.Order c : AbstractSimpleIterator.Order.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static AbstractSimpleIterator.Order valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null


Copyright © 2009-2013. All Rights Reserved.