Class CurrencyValue

java.lang.Object
com.azure.ai.documentintelligence.models.CurrencyValue
All Implemented Interfaces:
com.azure.json.JsonSerializable<CurrencyValue>

public final class CurrencyValue extends Object implements com.azure.json.JsonSerializable<CurrencyValue>
Currency field value.
  • Method Summary

    Modifier and Type
    Method
    Description
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of CurrencyValue from the JsonReader.
    double
    Get the amount property: Currency amount.
    Get the currencyCode property: Resolved currency code (ISO 4217), if any.
    Get the currencySymbol property: Currency symbol label, if any.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString
  • Method Details

    • getAmount

      public double getAmount()
      Get the amount property: Currency amount.
      Returns:
      the amount value.
    • getCurrencySymbol

      public String getCurrencySymbol()
      Get the currencySymbol property: Currency symbol label, if any.
      Returns:
      the currencySymbol value.
    • getCurrencyCode

      public String getCurrencyCode()
      Get the currencyCode property: Resolved currency code (ISO 4217), if any.
      Returns:
      the currencyCode value.
    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<CurrencyValue>
      Throws:
      IOException
    • fromJson

      public static CurrencyValue fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of CurrencyValue from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of CurrencyValue if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the CurrencyValue.