azure-docs-sdk-java/docs-ref-autogen/com.azure.core.models.GeoPo...

138 строки
13 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.core.models.GeoPointCollection"
fullName: "com.azure.core.models.GeoPointCollection"
name: "GeoPointCollection"
nameWithType: "GeoPointCollection"
summary: "Represents a collection of <xref uid=\"com.azure.core.models.GeoPoint\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPoints\"></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 **GeoPointCollection**</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.GeoPointCollection.GeoPointCollection(java.util.List<com.azure.core.models.GeoPoint>)"
fullName: "com.azure.core.models.GeoPointCollection.GeoPointCollection(List<GeoPoint> points)"
name: "GeoPointCollection(List<GeoPoint> points)"
nameWithType: "GeoPointCollection.GeoPointCollection(List<GeoPoint> points)"
summary: "Constructs a <xref uid=\"com.azure.core.models.GeoPointCollection\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPointCollection\"></xref>."
parameters:
- description: "The points that define the multi-point."
name: "points"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.core.models.GeoPoint?alt=com.azure.core.models.GeoPoint&text=GeoPoint\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public GeoPointCollection(List<GeoPoint> points)"
desc: "Constructs a <xref uid=\"com.azure.core.models.GeoPointCollection\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPointCollection\"></xref>."
- uid: "com.azure.core.models.GeoPointCollection.GeoPointCollection(java.util.List<com.azure.core.models.GeoPoint>,com.azure.core.models.GeoBoundingBox,java.util.Map<java.lang.String,java.lang.Object>)"
fullName: "com.azure.core.models.GeoPointCollection.GeoPointCollection(List<GeoPoint> points, GeoBoundingBox boundingBox, Map<String,Object> customProperties)"
name: "GeoPointCollection(List<GeoPoint> points, GeoBoundingBox boundingBox, Map<String,Object> customProperties)"
nameWithType: "GeoPointCollection.GeoPointCollection(List<GeoPoint> points, GeoBoundingBox boundingBox, Map<String,Object> customProperties)"
summary: "Constructs a <xref uid=\"com.azure.core.models.GeoPointCollection\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPointCollection\"></xref>."
parameters:
- description: "The points that define the multi-point."
name: "points"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.core.models.GeoPoint?alt=com.azure.core.models.GeoPoint&text=GeoPoint\" data-throw-if-not-resolved=\"False\" />&gt;"
- description: "Bounding box for the multi-point."
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-point."
name: "customProperties"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<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>&gt;"
syntax: "public GeoPointCollection(List<GeoPoint> points, GeoBoundingBox boundingBox, Map<String,Object> customProperties)"
desc: "Constructs a <xref uid=\"com.azure.core.models.GeoPointCollection\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPointCollection\"></xref>."
methods:
- uid: "com.azure.core.models.GeoPointCollection.equals(java.lang.Object)"
fullName: "com.azure.core.models.GeoPointCollection.equals(Object obj)"
name: "equals(Object obj)"
nameWithType: "GeoPointCollection.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.GeoPointCollection.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.core.models.GeoPointCollection.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "GeoPointCollection.fromJson(JsonReader jsonReader)"
summary: "Reads a JSON stream into a <xref uid=\"com.azure.core.models.GeoPointCollection\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPointCollection\"></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 GeoPointCollection fromJson(JsonReader jsonReader)"
exceptions:
- description: "If the <code>type</code> node exists and isn't equal to <code>MultiPoint</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.GeoPointCollection\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPointCollection\"></xref>."
returns:
description: "The <xref uid=\"com.azure.core.models.GeoPointCollection\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPointCollection\"></xref> that the JSON stream represented, or null if it pointed to JSON null."
type: "<xref href=\"com.azure.core.models.GeoPointCollection?alt=com.azure.core.models.GeoPointCollection&text=GeoPointCollection\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.models.GeoPointCollection.getPoints()"
fullName: "com.azure.core.models.GeoPointCollection.getPoints()"
name: "getPoints()"
nameWithType: "GeoPointCollection.getPoints()"
summary: "Unmodifiable representation of the <xref uid=\"com.azure.core.models.GeoPoint\" data-throw-if-not-resolved=\"false\" data-raw-source=\"geometric points\"></xref> representing this multi-point."
syntax: "public List<GeoPoint> getPoints()"
desc: "Unmodifiable representation of the <xref uid=\"com.azure.core.models.GeoPoint\" data-throw-if-not-resolved=\"false\" data-raw-source=\"geometric points\"></xref> representing this multi-point."
returns:
description: "An unmodifiable representation of the <xref uid=\"com.azure.core.models.GeoPoint\" data-throw-if-not-resolved=\"false\" data-raw-source=\"geometric points\"></xref> representing this multi-point."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.core.models.GeoPoint?alt=com.azure.core.models.GeoPoint&text=GeoPoint\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.core.models.GeoPointCollection.getType()"
fullName: "com.azure.core.models.GeoPointCollection.getType()"
name: "getType()"
nameWithType: "GeoPointCollection.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.GeoPointCollection.hashCode()"
fullName: "com.azure.core.models.GeoPointCollection.hashCode()"
name: "hashCode()"
nameWithType: "GeoPointCollection.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.GeoPointCollection.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.core.models.GeoPointCollection.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "GeoPointCollection.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.GeoPoint\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPoints\"></xref> in GeoJSON format.\n\nThis class encapsulates a list of <xref uid=\"com.azure.core.models.GeoPoint\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPoint\"></xref> instances that form a collection of points. Each point is defined by a <xref uid=\"com.azure.core.models.GeoPosition\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoPosition\"></xref> which includes the longitude, latitude, and optionally the altitude.\n\nThis class also provides a <xref uid=\"com.azure.core.models.GeoPointCollection.toJson(com.azure.json.JsonWriter)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#toJson(JsonWriter)\"></xref> method to serialize the collection of points to JSON, and a <xref uid=\"com.azure.core.models.GeoPointCollection.fromJson(com.azure.json.JsonReader)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromJson(JsonReader)\"></xref> method to deserialize a collection of points from JSON.\n\nNote:A point collection requires at least 2 coordinates for each point."
metadata: {}
package: "com.azure.core.models"
artifact: com.azure:azure-core:1.52.0