S2ShapeIndex.CellRelation (S2 Geometry Library for Java 2.0.0 API)

java.lang.Object
- java.lang.Enum<S2ShapeIndex.CellRelation>
- - com.google.common.geometry.S2ShapeIndex.CellRelation

All Implemented Interfaces:

Serializable, Comparable<S2ShapeIndex.CellRelation>

Enclosing class:

S2ShapeIndex
```
public static enum S2ShapeIndex.CellRelation
extends Enum<S2ShapeIndex.CellRelation>
```
The possible relationships between a "target" cell and the cells of the S2ShapeIndex. If the target is an index cell or is contained by an index cell, it is "INDEXED". If the target is subdivided into one or more index cells, it is "SUBDIVIDED". Otherwise it is "DISJOINT".

Enum Constant Summary

Enum Constants
Enum Constant	Description
`DISJOINT`	Target does not intersect any index cells.
`INDEXED`	Target is contained by an index cell.
`SUBDIVIDED`	Target is subdivided into one or more index cells.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static S2ShapeIndex.CellRelation`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static S2ShapeIndex.CellRelation[]`	`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
  - INDEXED
```
public static final S2ShapeIndex.CellRelation INDEXED
```
    Target is contained by an index cell.
  - SUBDIVIDED
```
public static final S2ShapeIndex.CellRelation SUBDIVIDED
```
    Target is subdivided into one or more index cells.
  - DISJOINT
```
public static final S2ShapeIndex.CellRelation DISJOINT
```
    Target does not intersect any index cells.
- Method Detail
  - values
```
public static S2ShapeIndex.CellRelation[] 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 (S2ShapeIndex.CellRelation c : S2ShapeIndex.CellRelation.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static S2ShapeIndex.CellRelation 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