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

135 строки
10 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.core.models.GeoObject"
fullName: "com.azure.core.models.GeoObject"
name: "GeoObject"
nameWithType: "GeoObject"
summary: "Represents an abstract geometric object in GeoJSON format."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- 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#equals-java.lang.Object-\">equals</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#hashCode--\">hashCode</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 abstract class **GeoObject**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.core.models.GeoObject?alt=com.azure.core.models.GeoObject&text=GeoObject\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.core.models.GeoObject.GeoObject(com.azure.core.models.GeoBoundingBox,java.util.Map<java.lang.String,java.lang.Object>)"
fullName: "com.azure.core.models.GeoObject.GeoObject(GeoBoundingBox boundingBox, Map<String,Object> customProperties)"
name: "GeoObject(GeoBoundingBox boundingBox, Map<String,Object> customProperties)"
nameWithType: "GeoObject.GeoObject(GeoBoundingBox boundingBox, Map<String,Object> customProperties)"
summary: "Creates a <xref uid=\"com.azure.core.models.GeoObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoObject\"></xref> instance."
modifiers:
- "protected"
parameters:
- description: "Optional bounding box of the <xref uid=\"com.azure.core.models.GeoObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoObject\"></xref>."
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: "Optional additional properties to associate to the <xref uid=\"com.azure.core.models.GeoObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoObject\"></xref>."
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: "protected GeoObject(GeoBoundingBox boundingBox, Map<String,Object> customProperties)"
desc: "Creates a <xref uid=\"com.azure.core.models.GeoObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoObject\"></xref> instance."
methods:
- uid: "com.azure.core.models.GeoObject.equals(java.lang.Object)"
fullName: "com.azure.core.models.GeoObject.equals(Object obj)"
name: "equals(Object obj)"
nameWithType: "GeoObject.equals(Object obj)"
overridden: "java.lang.Object.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.GeoObject.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.core.models.GeoObject.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "GeoObject.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of <xref uid=\"com.azure.core.models.GeoObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoObject\"></xref> from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader 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 GeoObject fromJson(JsonReader jsonReader)"
exceptions:
- description: "If the deserialized JSON object was missing any required properties or the\n polymorphic discriminator."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of <xref uid=\"com.azure.core.models.GeoObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoObject\"></xref> from the JsonReader."
returns:
description: "An instance of <xref uid=\"com.azure.core.models.GeoObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoObject\"></xref> if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: "<xref href=\"com.azure.core.models.GeoObject?alt=com.azure.core.models.GeoObject&text=GeoObject\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.models.GeoObject.getBoundingBox()"
fullName: "com.azure.core.models.GeoObject.getBoundingBox()"
name: "getBoundingBox()"
nameWithType: "GeoObject.getBoundingBox()"
summary: "Bounding box for this <xref uid=\"com.azure.core.models.GeoObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoObject\"></xref>."
modifiers:
- "final"
syntax: "public final GeoBoundingBox getBoundingBox()"
desc: "Bounding box for this <xref uid=\"com.azure.core.models.GeoObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoObject\"></xref>."
returns:
description: "The bounding box for this <xref uid=\"com.azure.core.models.GeoObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoObject\"></xref>."
type: "<xref href=\"com.azure.core.models.GeoBoundingBox?alt=com.azure.core.models.GeoBoundingBox&text=GeoBoundingBox\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.models.GeoObject.getCustomProperties()"
fullName: "com.azure.core.models.GeoObject.getCustomProperties()"
name: "getCustomProperties()"
nameWithType: "GeoObject.getCustomProperties()"
summary: "Additional properties about this <xref uid=\"com.azure.core.models.GeoObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoObject\"></xref>."
modifiers:
- "final"
syntax: "public final Map<String,Object> getCustomProperties()"
desc: "Additional properties about this <xref uid=\"com.azure.core.models.GeoObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoObject\"></xref>."
returns:
description: "An unmodifiable representation of the additional properties associated with this <xref uid=\"com.azure.core.models.GeoObject\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GeoObject\"></xref>."
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;"
- uid: "com.azure.core.models.GeoObject.getType()"
fullName: "com.azure.core.models.GeoObject.getType()"
name: "getType()"
nameWithType: "GeoObject.getType()"
summary: "Gets the GeoJSON type for this object."
modifiers:
- "abstract"
syntax: "public abstract GeoObjectType getType()"
desc: "Gets the GeoJSON type for this object."
returns:
description: "The GeoJSON type for this object."
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.GeoObject.hashCode()"
fullName: "com.azure.core.models.GeoObject.hashCode()"
name: "hashCode()"
nameWithType: "GeoObject.hashCode()"
overridden: "java.lang.Object.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.GeoObject.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.core.models.GeoObject.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "GeoObject.toJson(JsonWriter 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 an abstract geometric object in GeoJSON format.\n\nThis class encapsulates the common properties of a geometric object, including the bounding box and additional custom properties. It provides methods to access these properties.\n\nThis class also provides a <xref uid=\"com.azure.core.models.GeoObject.toJson(com.azure.json.JsonWriter)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#toJson(JsonWriter)\"></xref> method to serialize the geometric object to JSON, and a <xref uid=\"com.azure.core.models.GeoObject.fromJson(com.azure.json.JsonReader)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromJson(JsonReader)\"></xref> method to deserialize a geometric object from JSON."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.core.models.GeoObject?alt=com.azure.core.models.GeoObject&text=GeoObject\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.core.models"
artifact: com.azure:azure-core:1.52.0