org.opensha.commons.geo
Enum LocationUtils.Side

java.lang.Object
  java.lang.Enum<LocationUtils.Side>
      org.opensha.commons.geo.LocationUtils.Side

All Implemented Interfaces:

Serializable, Comparable<LocationUtils.Side>

Enclosing class:

LocationUtils

public static enum LocationUtils.Side
extends Enum<LocationUtils.Side>

Enum used indicate sidedness of points with respect to a line.

Enum Constant Summary

LEFT
Indicates a point is on the left side of a line.

ON
Indicates a point is on the a line.

RIGHT
Indicates a point is on the right side of a line.

Method Summary

static LocationUtils.Side	valueOf(String name) Returns the enum constant of this type with the specified name.
static LocationUtils.Side[]	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

RIGHT

public static final LocationUtils.Side RIGHT

Indicates a point is on the right side of a line.

LEFT

public static final LocationUtils.Side LEFT

Indicates a point is on the left side of a line.

ON

public static final LocationUtils.Side ON

Indicates a point is on the a line.

Method Detail

values

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

Returns:

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

valueOf

public static LocationUtils.Side 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