138 строки
13 KiB
YAML
138 строки
13 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.models.GeoPolygonCollection"
|
|
fullName: "com.azure.core.models.GeoPolygonCollection"
|
|
name: "GeoPolygonCollection"
|
|
nameWithType: "GeoPolygonCollection"
|
|
summary: "Represents a collection of <xref uid=\"com.azure.core.models.GeoPolygon\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPolygons\"></xref> in GeoJSON format."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.models.GeoObject?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.core.models.GeoObject?alt=com.azure.core.models.GeoObject&text=GeoObject\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.core.models.GeoObject.equals(java.lang.Object)?alt=com.azure.core.models.GeoObject.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.models.GeoObject.fromJson(com.azure.json.JsonReader)?alt=com.azure.core.models.GeoObject.fromJson&text=fromJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.models.GeoObject.getBoundingBox()?alt=com.azure.core.models.GeoObject.getBoundingBox&text=getBoundingBox\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.models.GeoObject.getCustomProperties()?alt=com.azure.core.models.GeoObject.getCustomProperties&text=getCustomProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.models.GeoObject.getType()?alt=com.azure.core.models.GeoObject.getType&text=getType\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.models.GeoObject.hashCode()?alt=com.azure.core.models.GeoObject.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.core.models.GeoObject.toJson(com.azure.json.JsonWriter)?alt=com.azure.core.models.GeoObject.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **GeoPolygonCollection**</br> extends <xref href=\"com.azure.core.models.GeoObject?alt=com.azure.core.models.GeoObject&text=GeoObject\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.core.models.GeoPolygonCollection.GeoPolygonCollection(java.util.List<com.azure.core.models.GeoPolygon>)"
|
|
fullName: "com.azure.core.models.GeoPolygonCollection.GeoPolygonCollection(List<GeoPolygon> polygons)"
|
|
name: "GeoPolygonCollection(List<GeoPolygon> polygons)"
|
|
nameWithType: "GeoPolygonCollection.GeoPolygonCollection(List<GeoPolygon> polygons)"
|
|
summary: "Constructs a <xref uid=\"com.azure.core.models.GeoPolygonCollection\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPolygonCollection\"></xref>."
|
|
parameters:
|
|
- description: "The polygons that define the multi-polygon."
|
|
name: "polygons"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.core.models.GeoPolygon?alt=com.azure.core.models.GeoPolygon&text=GeoPolygon\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public GeoPolygonCollection(List<GeoPolygon> polygons)"
|
|
desc: "Constructs a <xref uid=\"com.azure.core.models.GeoPolygonCollection\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPolygonCollection\"></xref>."
|
|
- uid: "com.azure.core.models.GeoPolygonCollection.GeoPolygonCollection(java.util.List<com.azure.core.models.GeoPolygon>,com.azure.core.models.GeoBoundingBox,java.util.Map<java.lang.String,java.lang.Object>)"
|
|
fullName: "com.azure.core.models.GeoPolygonCollection.GeoPolygonCollection(List<GeoPolygon> polygons, GeoBoundingBox boundingBox, Map<String,Object> customProperties)"
|
|
name: "GeoPolygonCollection(List<GeoPolygon> polygons, GeoBoundingBox boundingBox, Map<String,Object> customProperties)"
|
|
nameWithType: "GeoPolygonCollection.GeoPolygonCollection(List<GeoPolygon> polygons, GeoBoundingBox boundingBox, Map<String,Object> customProperties)"
|
|
summary: "Constructs a <xref uid=\"com.azure.core.models.GeoPolygonCollection\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPolygonCollection\"></xref>."
|
|
parameters:
|
|
- description: "The polygons that define the multi-polygon."
|
|
name: "polygons"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.core.models.GeoPolygon?alt=com.azure.core.models.GeoPolygon&text=GeoPolygon\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "Bounding box for the multi-polygon."
|
|
name: "boundingBox"
|
|
type: "<xref href=\"com.azure.core.models.GeoBoundingBox?alt=com.azure.core.models.GeoBoundingBox&text=GeoBoundingBox\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Additional properties of the multi-polygon."
|
|
name: "customProperties"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
|
|
syntax: "public GeoPolygonCollection(List<GeoPolygon> polygons, GeoBoundingBox boundingBox, Map<String,Object> customProperties)"
|
|
desc: "Constructs a <xref uid=\"com.azure.core.models.GeoPolygonCollection\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPolygonCollection\"></xref>."
|
|
methods:
|
|
- uid: "com.azure.core.models.GeoPolygonCollection.equals(java.lang.Object)"
|
|
fullName: "com.azure.core.models.GeoPolygonCollection.equals(Object obj)"
|
|
name: "equals(Object obj)"
|
|
nameWithType: "GeoPolygonCollection.equals(Object obj)"
|
|
overridden: "com.azure.core.models.GeoObject.equals(java.lang.Object)"
|
|
parameters:
|
|
- name: "obj"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
syntax: "public boolean equals(Object obj)"
|
|
returns:
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.models.GeoPolygonCollection.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.core.models.GeoPolygonCollection.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "GeoPolygonCollection.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads a JSON stream into a <xref uid=\"com.azure.core.models.GeoPolygonCollection\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPolygonCollection\"></xref>."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.json.JsonReader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JsonReader\"></xref> being read."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static GeoPolygonCollection fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If the <code>type</code> node exists and isn't equal to <code>MultiPolygon</code>."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads a JSON stream into a <xref uid=\"com.azure.core.models.GeoPolygonCollection\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPolygonCollection\"></xref>."
|
|
returns:
|
|
description: "The <xref uid=\"com.azure.core.models.GeoPolygonCollection\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPolygonCollection\"></xref> that the JSON stream represented, or null if it pointed to JSON null."
|
|
type: "<xref href=\"com.azure.core.models.GeoPolygonCollection?alt=com.azure.core.models.GeoPolygonCollection&text=GeoPolygonCollection\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.models.GeoPolygonCollection.getPolygons()"
|
|
fullName: "com.azure.core.models.GeoPolygonCollection.getPolygons()"
|
|
name: "getPolygons()"
|
|
nameWithType: "GeoPolygonCollection.getPolygons()"
|
|
summary: "Unmodifiable representation of the <xref uid=\"com.azure.core.models.GeoPolygon\" data-throw-if-not-resolved=\"false\" data-raw-source=\"geometric polygons\"></xref> representing this multi-polygon."
|
|
syntax: "public List<GeoPolygon> getPolygons()"
|
|
desc: "Unmodifiable representation of the <xref uid=\"com.azure.core.models.GeoPolygon\" data-throw-if-not-resolved=\"false\" data-raw-source=\"geometric polygons\"></xref> representing this multi-polygon."
|
|
returns:
|
|
description: "An unmodifiable representation of the <xref uid=\"com.azure.core.models.GeoPolygon\" data-throw-if-not-resolved=\"false\" data-raw-source=\"geometric polygons\"></xref> representing this\n multi-polygon."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.core.models.GeoPolygon?alt=com.azure.core.models.GeoPolygon&text=GeoPolygon\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.core.models.GeoPolygonCollection.getType()"
|
|
fullName: "com.azure.core.models.GeoPolygonCollection.getType()"
|
|
name: "getType()"
|
|
nameWithType: "GeoPolygonCollection.getType()"
|
|
summary: "Gets the GeoJSON type for this object."
|
|
overridden: "com.azure.core.models.GeoObject.getType()"
|
|
syntax: "public GeoObjectType getType()"
|
|
desc: "Gets the GeoJSON type for this object."
|
|
returns:
|
|
type: "<xref href=\"com.azure.core.models.GeoObjectType?alt=com.azure.core.models.GeoObjectType&text=GeoObjectType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.models.GeoPolygonCollection.hashCode()"
|
|
fullName: "com.azure.core.models.GeoPolygonCollection.hashCode()"
|
|
name: "hashCode()"
|
|
nameWithType: "GeoPolygonCollection.hashCode()"
|
|
overridden: "com.azure.core.models.GeoObject.hashCode()"
|
|
syntax: "public int hashCode()"
|
|
returns:
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.models.GeoPolygonCollection.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.core.models.GeoPolygonCollection.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "GeoPolygonCollection.toJson(JsonWriter jsonWriter)"
|
|
overridden: "com.azure.core.models.GeoObject.toJson(com.azure.json.JsonWriter)"
|
|
parameters:
|
|
- name: "jsonWriter"
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Represents a collection of <xref uid=\"com.azure.core.models.GeoPolygon\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPolygons\"></xref> in GeoJSON format.\n\nThis class encapsulates a list of <xref uid=\"com.azure.core.models.GeoPolygon\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPolygon\"></xref> instances that form a collection of polygons. Each polygon is defined by a list of <xref uid=\"com.azure.core.models.GeoLinearRing\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoLinearRing\"></xref> instances that form the boundary of the polygon.\n\nThis class also provides a <xref uid=\"com.azure.core.models.GeoPolygonCollection.toJson(com.azure.json.JsonWriter)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#toJson(JsonWriter)\"></xref> method to serialize the collection of polygons to JSON, and a <xref uid=\"com.azure.core.models.GeoPolygonCollection.fromJson(com.azure.json.JsonReader)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromJson(JsonReader)\"></xref> method to deserialize a collection of polygons from JSON.\n\nThis 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.\n\nNote: 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)."
|
|
metadata: {}
|
|
package: "com.azure.core.models"
|
|
artifact: com.azure:azure-core:1.54.0
|