Package com.azure.core.models

Class GeoPointCollection

java.lang.Object

com.azure.core.models.GeoObject

com.azure.core.models.GeoPointCollection

All Implemented Interfaces:

com.azure.json.JsonSerializable<GeoObject>

public final class GeoPointCollection
extends GeoObject

Represents a collection of GeoPoints in GeoJSON format.

This class encapsulates a list of GeoPoint instances that form a collection of points. Each point is defined by a GeoPosition which includes the longitude, latitude, and optionally the altitude.

This class also provides a toJson(JsonWriter) method to serialize the collection of points to JSON, and a fromJson(JsonReader) method to deserialize a collection of points from JSON.

Note:A point collection requires at least 2 coordinates for each point.

See Also:

• GeoPoint
• GeoPosition
• GeoObject
• JsonSerializable

Constructor Summary

Constructors

Constructor	Description
GeoPointCollection(List<GeoPoint> points)	Constructs a GeoPointCollection.
GeoPointCollection(List<GeoPoint> points, GeoBoundingBox boundingBox, Map<String,Object> customProperties)	Constructs a GeoPointCollection.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static GeoPointCollection	fromJson(com.azure.json.JsonReader jsonReader)	Reads a JSON stream into a GeoPointCollection.
List<GeoPoint>	getPoints()	Unmodifiable representation of the geometric points representing this multi-point.
GeoObjectType	getType()	Gets the GeoJSON type for this object.
int	hashCode()
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class com.azure.core.models.GeoObject

getBoundingBox, getCustomProperties

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

GeoPointCollection

public GeoPointCollection(List<GeoPoint> points)

Constructs a GeoPointCollection.

Parameters:

points - The points that define the multi-point.

Throws:

NullPointerException - If points is null.

GeoPointCollection

public GeoPointCollection(List<GeoPoint> points,
 GeoBoundingBox boundingBox,
 Map<String,Object> customProperties)

Constructs a GeoPointCollection.

Parameters:

points - The points that define the multi-point.

boundingBox - Bounding box for the multi-point.

customProperties - Additional properties of the multi-point.

Throws:

NullPointerException - If points is null.

Method Details

getPoints

public List<GeoPoint> getPoints()

Unmodifiable representation of the geometric points representing this multi-point.

Returns:

An unmodifiable representation of the geometric points representing this multi-point.

getType

public GeoObjectType getType()

Description copied from class: GeoObject

Gets the GeoJSON type for this object.

Specified by:

getType in class GeoObject

Returns:

The GeoJSON type for this object.

hashCode

public int hashCode()

Overrides:

hashCode in class GeoObject

equals

public boolean equals(Object obj)

Overrides:

equals in class GeoObject

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<GeoObject>

Overrides:

toJson in class GeoObject

Throws:

IOException

fromJson

public static GeoPointCollection fromJson(com.azure.json.JsonReader jsonReader)
                                   throws IOException

Reads a JSON stream into a GeoPointCollection.

Parameters:

jsonReader - The JsonReader being read.

Returns:

The GeoPointCollection that the JSON stream represented, or null if it pointed to JSON null.

Throws:

IllegalStateException - If the type node exists and isn't equal to MultiPoint.

IOException - If a GeoPointCollection fails to be read from the jsonReader.