Package com.azure.core.models

Class GeoBoundingBox

java.lang.Object
com.azure.core.models.GeoBoundingBox
All Implemented Interfaces:
com.azure.json.JsonSerializable<GeoBoundingBox>
public final class GeoBoundingBox extends Object implements com.azure.json.JsonSerializable<GeoBoundingBox>
Represents a geometric bounding box.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GeoBoundingBox(double west, double south, double east, double north)
    Constructs a bounding box.
    GeoBoundingBox(double west, double south, double east, double north, double minAltitude, double maxAltitude)
    Constructs a bounding box.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static GeoBoundingBox
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads a JSON stream into a GeoBoundingBox.
    double
    getEast()
    The east longitudinal boundary of the bounding box.
    Double
    getMaxAltitude()
    The maximum altitude boundary of the bounding box.
    Double
    getMinAltitude()
    The minimum altitude boundary of the bounding box.
    double
    getNorth()
    The north latitudinal boundary of the bounding box.
    double
    getSouth()
    The south latitudinal boundary of the bounding box.
    double
    getWest()
    The west longitudinal boundary of the bounding box.
    int
    hashCode()
     
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    Writes the object to the passed JsonWriter.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • GeoBoundingBox

      public GeoBoundingBox(double west, double south, double east, double north)
      Constructs a bounding box.
      Parameters:
      west - West longitudinal boundary.
      south - South latitudinal boundary.
      east - East longitudinal boundary.
      north - North latitudinal boundary.

    • GeoBoundingBox

      public GeoBoundingBox(double west, double south, double east, double north, double minAltitude, double maxAltitude)
      Constructs a bounding box.
      Parameters:
      west - West longitudinal boundary.
      south - South latitudinal boundary.
      east - East longitudinal boundary.
      north - North latitudinal boundary.
      minAltitude - Minimum altitude boundary.
      maxAltitude - Maximum altitude boundary.

  • Method Details

    • getWest

      public double getWest()
      The west longitudinal boundary of the bounding box.
      Returns:
      The west longitudinal boundary.

    • getSouth

      public double getSouth()
      The south latitudinal boundary of the bounding box.
      Returns:
      The south latitudinal boundary.

    • getEast

      public double getEast()
      The east longitudinal boundary of the bounding box.
      Returns:
      The east longitudinal boundary.

    • getNorth

      public double getNorth()
      The north latitudinal boundary of the bounding box.
      Returns:
      The north latitudinal boundary.

    • getMinAltitude

      public Double getMinAltitude()
      The minimum altitude boundary of the bounding box.
      Returns:
      The minimum altitude boundary.

    • getMaxAltitude

      public Double getMaxAltitude()
      The maximum altitude boundary of the bounding box.
      Returns:
      The maximum altitude boundary.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • 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<GeoBoundingBox>
      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 GeoBoundingBox fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads a JSON stream into a GeoBoundingBox.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      The GeoBoundingBox that the JSON stream represented, or null if it pointed to JSON null.
      Throws:
      IllegalStateException - If the GeoBoundingBox doesn't have four or six positions in the array.
      IOException - If a GeoBoundingBox fails to be read from the jsonReader.