Package com.azure.core.models

Class GeoPolygonCollection

java.lang.Object

com.azure.core.models.GeoObject

com.azure.core.models.GeoPolygonCollection

All Implemented Interfaces:

com.azure.json.JsonSerializable<GeoObject>

public final class GeoPolygonCollection
extends GeoObject

Represents a collection of GeoPolygons in GeoJSON format.

This class encapsulates a list of GeoPolygon instances that form a collection of polygons. Each polygon is defined by a list of GeoLinearRing instances that form the boundary of the polygon.

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

This class is useful when you want to work with a collection of polygons in a geographic context. For example, you can use it to represent a complex geographic area on a map that is composed of multiple polygons.

Note: A polygon collection requires at least one ring for each polygon, and each ring requires at least 4 coordinates (with the first and last coordinates being the same to form a closed loop).

See Also:

• GeoPolygon
• GeoLinearRing
• GeoPosition
• GeoObject
• JsonSerializable

Constructor Summary

Constructors

Constructor	Description
GeoPolygonCollection(List<GeoPolygon> polygons)	Constructs a GeoPolygonCollection.
GeoPolygonCollection(List<GeoPolygon> polygons, GeoBoundingBox boundingBox, Map<String,Object> customProperties)	Constructs a GeoPolygonCollection.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static GeoPolygonCollection	fromJson(com.azure.json.JsonReader jsonReader)	Reads a JSON stream into a GeoPolygonCollection.
List<GeoPolygon>	getPolygons()	Unmodifiable representation of the geometric polygons representing this multi-polygon.
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

GeoPolygonCollection

public GeoPolygonCollection(List<GeoPolygon> polygons)

Constructs a GeoPolygonCollection.

Parameters:

polygons - The polygons that define the multi-polygon.

Throws:

NullPointerException - If polygons is null.

GeoPolygonCollection

public GeoPolygonCollection(List<GeoPolygon> polygons,
 GeoBoundingBox boundingBox,
 Map<String,Object> customProperties)

Constructs a GeoPolygonCollection.

Parameters:

polygons - The polygons that define the multi-polygon.

boundingBox - Bounding box for the multi-polygon.

customProperties - Additional properties of the multi-polygon.

Throws:

NullPointerException - If polygons is null.

Method Details

getPolygons

public List<GeoPolygon> getPolygons()

Unmodifiable representation of the geometric polygons representing this multi-polygon.

Returns:

An unmodifiable representation of the geometric polygons representing this multi-polygon.

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

Reads a JSON stream into a GeoPolygonCollection.

Parameters:

jsonReader - The JsonReader being read.

Returns:

The GeoPolygonCollection 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 MultiPolygon.

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