org.geotools.grid
Enum Neighbor

Object
  extended by Enum<Neighbor>
      extended by Neighbor
All Implemented Interfaces:
Serializable, Comparable<Neighbor>

public enum Neighbor
extends Enum<Neighbor>

Constants for neighbor positions used when bulding polygonal grids.

Since:
2.7
Author:
mbedward

Enum Constant Summary
LEFT
           
LOWER
           
LOWER_LEFT
           
LOWER_RIGHT
           
RIGHT
           
UPPER
           
UPPER_LEFT
           
UPPER_RIGHT
           
 
Method Summary
static Neighbor valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Neighbor[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

UPPER

public static final Neighbor UPPER

UPPER_LEFT

public static final Neighbor UPPER_LEFT

UPPER_RIGHT

public static final Neighbor UPPER_RIGHT

LOWER

public static final Neighbor LOWER

LOWER_LEFT

public static final Neighbor LOWER_LEFT

LOWER_RIGHT

public static final Neighbor LOWER_RIGHT

LEFT

public static final Neighbor LEFT

RIGHT

public static final Neighbor RIGHT
Method Detail

values

public static Neighbor[] 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 (Neighbor c : Neighbor.values())
    System.out.println(c);

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

valueOf

public static Neighbor 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 © 1996-2014 Geotools. All Rights Reserved.