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.

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)	Writes the object to the passed 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

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

Description copied from interface: com.azure.json.JsonSerializable

Writes the object to the passed JsonWriter.

The contract for writing JSON to JsonWriter is that the object being written will handle opening and closing its own JSON object. So, for objects calling out to other JsonSerializable objects for serialization, they'll write the field name only then pass the JsonWriter to the other JsonSerializable object. This way objects writing JSON will be self-encapsulated for writing properly formatted JSON.

Specified by:

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

Overrides:

toJson in class GeoObject

Parameters:

jsonWriter - Where the object's JSON will be written.

Returns:

The JsonWriter where the JSON was written.

Throws:

IOException - If the object fails to be written to the jsonWriter.

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.