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.

  • 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
      Description copied from interface: com.azure.json.JsonSerializable
      Writes the object to the passed JsonWriter.

      The contract for writing JSON to JsonWriter is that the object being written will handle opening and closing its own JSON object. So, for objects calling out to other JsonSerializable objects for serialization, they'll write the field name only then pass the JsonWriter to the other JsonSerializable object. This way objects writing JSON will be self-encapsulated for writing properly formatted JSON.

      Specified by:
      toJson in interface com.azure.json.JsonSerializable<GeoObject>
      Overrides:
      toJson in class GeoObject
      Parameters:
      jsonWriter - Where the object's JSON will be written.
      Returns:
      The JsonWriter where the JSON was written.
      Throws:
      IOException - If the object fails to be written to the jsonWriter.

    • 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.