Package org.apache.lucene.geo
Enum Component2D.WithinRelation
- All Implemented Interfaces:
Serializable
,Comparable<Component2D.WithinRelation>
- Enclosing interface:
- Component2D
Used by withinTriangle to check the within relationship between a triangle and the query shape
(e.g. if the query shape is within the triangle).
-
Enum Constant Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Component2D.WithinRelation
Returns the enum constant of this type with the specified name.static Component2D.WithinRelation[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
CANDIDATE
If the shape is a candidate for within. Typically this is return if the query shape is fully inside the triangle or if the query shape intersects only edges that do not belong to the original shape. -
NOTWITHIN
The query shape intersects an edge that does belong to the original shape or any point of the triangle is inside the shape. -
DISJOINT
The query shape is disjoint with the triangle.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException
- if the argument is null
-