Package com.azure.core.models

Class GeoCollection

java.lang.Object

com.azure.core.models.GeoObject

com.azure.core.models.GeoCollection

All Implemented Interfaces:

com.azure.json.JsonSerializable<GeoObject>

public final class GeoCollection
extends GeoObject

Represents a heterogeneous collection of GeoObjects.

This class encapsulates a list of geometry objects and provides methods to access these objects. The objects can be of any type that extends GeoObject.

This class is useful when you want to work with a collection of geometry objects in a read-only manner. For example, you can use it to represent a complex geographic feature that is composed of multiple simple geographic features.

See Also:

• GeoObject
• GeoBoundingBox

Constructor Summary

Constructors

Constructor	Description
GeoCollection(List<GeoObject> geometries)	Constructs a GeoCollection.
GeoCollection(List<GeoObject> geometries, GeoBoundingBox boundingBox, Map<String,Object> customProperties)	Constructs a GeoCollection.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static GeoCollection	fromJson(com.azure.json.JsonReader jsonReader)	Reads a JSON stream into a GeoCollection.
List<GeoObject>	getGeometries()	Unmodifiable representation of the geometries contained in this collection.
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

GeoCollection

public GeoCollection(List<GeoObject> geometries)

Constructs a GeoCollection.

Parameters:

geometries - The geometries in the collection.

Throws:

NullPointerException - If geometries is null.

GeoCollection

public GeoCollection(List<GeoObject> geometries,
 GeoBoundingBox boundingBox,
 Map<String,Object> customProperties)

Constructs a GeoCollection.

Parameters:

geometries - The geometries in the collection.

boundingBox - Bounding box for the GeoCollection.

customProperties - Additional properties of the GeoCollection.

Throws:

NullPointerException - If geometries is null.

Method Details

getGeometries

public List<GeoObject> getGeometries()

Unmodifiable representation of the geometries contained in this collection.

Returns:

An unmodifiable representation of the geometries in this collection.

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 GeoCollection fromJson(com.azure.json.JsonReader jsonReader)
                              throws IOException

Reads a JSON stream into a GeoCollection.

Parameters:

jsonReader - The JsonReader being read.

Returns:

The GeoCollection 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 GeometryCollection.

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