Package com.azure.core.models

Class GeoLineString

java.lang.Object

com.azure.core.models.GeoObject

com.azure.core.models.GeoLineString

All Implemented Interfaces:

com.azure.json.JsonSerializable<GeoObject>

public final class GeoLineString
extends GeoObject

Represents a geometric line string.

This class encapsulates a list of GeoPosition instances that form a line string. A line string is a curve with linear interpolation between points.

This class is useful when you want to work with a line string in a geographic context. For example, you can use it to represent a route on a map or the shape of a geographic feature.

Note: A line string requires at least 2 coordinates.

See Also:

• GeoPosition
• GeoObject
• JsonSerializable

Constructor Summary

Constructors

Constructor	Description
GeoLineString(List<GeoPosition> positions)	Constructs a geometric line.
GeoLineString(List<GeoPosition> positions, GeoBoundingBox boundingBox, Map<String,Object> customProperties)	Constructs a geometric line.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static GeoLineString	fromJson(com.azure.json.JsonReader jsonReader)	Reads a JSON stream into a GeoLineString.
List<GeoPosition>	getCoordinates()	Unmodifiable representation of the geometric positions representing this line.
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

GeoLineString

public GeoLineString(List<GeoPosition> positions)

Constructs a geometric line.

Parameters:

positions - Geometric positions that define the line.

Throws:

NullPointerException - If positions is null.

GeoLineString

public GeoLineString(List<GeoPosition> positions,
 GeoBoundingBox boundingBox,
 Map<String,Object> customProperties)

Constructs a geometric line.

Parameters:

positions - Geometric positions that define the line.

boundingBox - Bounding box for the line.

customProperties - Additional properties of the geometric line.

Throws:

NullPointerException - If positions is null.

Method Details

getCoordinates

public List<GeoPosition> getCoordinates()

Unmodifiable representation of the geometric positions representing this line.

Returns:

An unmodifiable representation of the geometric positions representing this line.

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

Reads a JSON stream into a GeoLineString.

Parameters:

jsonReader - The JsonReader being read.

Returns:

The GeoLineString 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 LineString.

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