Package com.azure.core.models

Class GeoLineStringCollection

java.lang.Object

com.azure.core.models.GeoObject

com.azure.core.models.GeoLineStringCollection

All Implemented Interfaces:

com.azure.json.JsonSerializable<GeoObject>

public final class GeoLineStringCollection
extends GeoObject

Represents a collection of GeoLineStrings.

This class encapsulates a list of GeoLineString instances that form a collection of lines. Each line string is a curve with linear interpolation between points.

This class is useful when you want to work with a collection of line strings in a geographic context. For example, you can use it to represent a complex route on a map that is composed of multiple line strings.

Note: A line string collection requires at least 2 coordinates for each line string.

See Also:

• GeoLineString
• GeoObject
• JsonSerializable

Constructor Summary

Constructors

Constructor	Description
GeoLineStringCollection(List<GeoLineString> lines)	Constructs a GeoLineStringCollection.
GeoLineStringCollection(List<GeoLineString> lines, GeoBoundingBox boundingBox, Map<String,Object> customProperties)	Constructs a GeoLineStringCollection.

Method Summary

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

GeoLineStringCollection

public GeoLineStringCollection(List<GeoLineString> lines)

Constructs a GeoLineStringCollection.

Parameters:

lines - The geometric lines that define the multi-line.

Throws:

NullPointerException - If lines is null.

GeoLineStringCollection

public GeoLineStringCollection(List<GeoLineString> lines,
 GeoBoundingBox boundingBox,
 Map<String,Object> customProperties)

Constructs a GeoLineStringCollection.

Parameters:

lines - The geometric lines that define the multi-line.

boundingBox - Bounding box for the multi-line.

customProperties - Additional properties of the multi-line.

Throws:

NullPointerException - If lines is null.

Method Details

getLines

public List<GeoLineString> getLines()

Unmodifiable representation of the geometric lines representing this multi-line.

Returns:

An unmodifiable representation of the geometric lines representing this multi-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 GeoLineStringCollection fromJson(com.azure.json.JsonReader jsonReader)
                                        throws IOException

Reads a JSON stream into a GeoLineStringCollection.

Parameters:

jsonReader - The JsonReader being read.

Returns:

The GeoLineStringCollection 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 MultiLineString.

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