Package com.azure.core.models

Class GeoPoint

java.lang.Object

com.azure.core.models.GeoObject

com.azure.core.models.GeoPoint

All Implemented Interfaces:

com.azure.json.JsonSerializable<GeoObject>

public final class GeoPoint
extends GeoObject

Represents a geometric point in GeoJSON format.

This class encapsulates a point defined by a GeoPosition which includes the longitude, latitude, and optionally the altitude of the point.

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

See Also:

• GeoPosition
• GeoObject
• JsonSerializable

Constructor Summary

Constructors

Constructor	Description
GeoPoint(double longitude, double latitude)	Constructs a GeoPoint.
GeoPoint(double longitude, double latitude, Double altitude)	Constructs a GeoPoint.
GeoPoint(GeoPosition position)	Constructs a geometric point.
GeoPoint(GeoPosition position, GeoBoundingBox boundingBox, Map<String,Object> customProperties)	Constructs a geometric point.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static GeoPoint	fromJson(com.azure.json.JsonReader jsonReader)	Reads a JSON stream into a GeoPoint.
GeoPosition	getCoordinates()	The geometric position of the point.
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

GeoPoint

public GeoPoint(double longitude,
 double latitude)

Constructs a GeoPoint.

Parameters:

longitude - The longitudinal position of the point.

latitude - The latitudinal position of the point.

GeoPoint

public GeoPoint(double longitude,
 double latitude,
 Double altitude)

Constructs a GeoPoint.

Parameters:

longitude - The longitudinal position of the point.

latitude - The latitudinal position of the point.

altitude - The altitude of the point.

GeoPoint

public GeoPoint(GeoPosition position)

Constructs a geometric point.

Parameters:

position - The geometric position of the point.

Throws:

NullPointerException - If position is null.

GeoPoint

public GeoPoint(GeoPosition position,
 GeoBoundingBox boundingBox,
 Map<String,Object> customProperties)

Constructs a geometric point.

Parameters:

position - The geometric position of the point.

boundingBox - Bounding box for the point.

customProperties - Additional properties of the geometric point.

Throws:

NullPointerException - If position is null.

Method Details

getCoordinates

public GeoPosition getCoordinates()

The geometric position of the point.

Returns:

The geometric position of the point.

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

Reads a JSON stream into a GeoPoint.

Parameters:

jsonReader - The JsonReader being read.

Returns:

The GeoPoint 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 Point.

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