com.revolsys.jts.geom

Enum Location

java.lang.Object

java.lang.Enum<Location>

com.revolsys.jts.geom.Location

All Implemented Interfaces:

Serializable, Comparable<Location>

public enum Location
extends Enum<Location>

Constants representing the different topological locations which can occur in a Geometry. The constants are also used as the row and column indices of DE-9IM IntersectionMatrixes.

Version:

1.7

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOUNDARY The location value for the boundary of a geometry.
EXTERIOR The location value for the exterior of a geometry.
INTERIOR The location value for the interior of a geometry.
NONE Used for uninitialized location values.

Method Summary

Methods

Modifier and Type	Method and Description
int	getIndex()
static char	toLocationSymbol(Location locationValue) Converts the location value to a location symbol, for example, EXTERIOR => 'e' .
String	toString()
static Location	valueOf(String name) Returns the enum constant of this type with the specified name.
static Location[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final Location NONE

Used for uninitialized location values.

INTERIOR

public static final Location INTERIOR

The location value for the interior of a geometry. Also, DE-9IM row index of the interior of the first geometry and column index of the interior of the second geometry.

BOUNDARY

public static final Location BOUNDARY

The location value for the boundary of a geometry. Also, DE-9IM row index of the boundary of the first geometry and column index of the boundary of the second geometry.

EXTERIOR

public static final Location EXTERIOR

The location value for the exterior of a geometry. Also, DE-9IM row index of the exterior of the first geometry and column index of the exterior of the second geometry.

Method Detail

values

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

Returns:

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

valueOf

public static Location 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

toLocationSymbol

public static char toLocationSymbol(Location locationValue)

Converts the location value to a location symbol, for example, EXTERIOR => 'e' .

Parameters:

locationValue - either EXTERIOR, BOUNDARY, INTERIOR or NONE

Returns:

either 'e', 'b', 'i' or '-'

getIndex

public int getIndex()

toString

public String toString()

Overrides:

toString in class Enum<Location>