com.microsoft.azure.cosmosdb

Enum SpatialType

java.lang.Object

java.lang.Enum<SpatialType>

com.microsoft.azure.cosmosdb.SpatialType

All Implemented Interfaces:

Serializable, Comparable<SpatialType>

public enum SpatialType
extends Enum<SpatialType>

Defines the target data type of an index path specification in the Azure Cosmos DB service.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LineString Represent a line string data type.
MultiPolygon Represent a multi-polygon data type.
Point Represent a point data type.
Polygon Represent a polygon data type.

Method Summary

Modifier and Type	Method and Description
static SpatialType	valueOf(String name) Returns the enum constant of this type with the specified name.
static SpatialType[]	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

Point

public static final SpatialType Point

Represent a point data type.

LineString

public static final SpatialType LineString

Represent a line string data type.

Polygon

public static final SpatialType Polygon

Represent a polygon data type.

MultiPolygon

public static final SpatialType MultiPolygon

Represent a multi-polygon data type.

Method Detail

values

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

Returns:

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

valueOf

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