Package org.apache.commons.geometry.core
Enum RegionLocation
- java.lang.Object
-
- java.lang.Enum<RegionLocation>
-
- org.apache.commons.geometry.core.RegionLocation
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<RegionLocation>
public enum RegionLocation extends java.lang.Enum<RegionLocation>
Enumeration containing the possible locations of a point with respect to a region.- See Also:
Region
-
-
Constructor Summary
Constructors Modifier Constructor Description private
RegionLocation()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static RegionLocation
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static RegionLocation[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
INSIDE
public static final RegionLocation INSIDE
Value indicating that a point lies on the inside of a region.
-
OUTSIDE
public static final RegionLocation OUTSIDE
Value indicating that a point lies on the outside of a region.
-
BOUNDARY
public static final RegionLocation BOUNDARY
Value indicating that a point lies on the boundary of a region.
-
-
Method Detail
-
values
public static RegionLocation[] 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 (RegionLocation c : RegionLocation.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static RegionLocation valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-