Partilhar via

AddressValue Class

  • Reference
Package:
com.azure.ai.documentintelligence.models
Maven Artifact:
com.azure:azure-ai-documentintelligence:1.0.0
  • java.lang.Object
    • com.azure.ai.documentintelligence.models.AddressValue

Implements

JsonSerializable<AddressValue>

public final class AddressValue
implements JsonSerializable<AddressValue>

Address field value.

Method Summary

Modifier and Type Method and Description
static AddressValue fromJson(JsonReader jsonReader)

Reads an instance of AddressValue from the JsonReader.
String getCity()

Get the city property: Name of city, town, village, etc.
String getCityDistrict()

Get the cityDistrict property: Districts or boroughs within a city, such as Brooklyn in New York City or City of Westminster in London.
String getCountryRegion()

Get the countryRegion property: Country/region.
String getHouse()

Get the house property: Build name, such as World Trade Center.
String getHouseNumber()

Get the houseNumber property: House or building number.
String getLevel()

Get the level property: Floor number, such as 3F.
String getPoBox()

Get the poBox property: Post office box number.
String getPostalCode()

Get the postalCode property: Postal code used for mail sorting.
String getRoad()

Get the road property: Street name.
String getState()

Get the state property: First-level administrative division.
String getStateDistrict()

Get the stateDistrict property: Second-level administrative division used in certain locales.
String getStreetAddress()

Get the streetAddress property: Street-level address, excluding city, state, countryRegion, and postalCode.
String getSuburb()

Get the suburb property: Unofficial neighborhood name, like Chinatown.
String getUnit()

Get the unit property: Apartment or office number.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static AddressValue fromJson(JsonReader jsonReader)

Reads an instance of AddressValue from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AddressValue if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the AddressValue.

getCity

public String getCity()

Get the city property: Name of city, town, village, etc.

Returns:

the city value.

getCityDistrict

public String getCityDistrict()

Get the cityDistrict property: Districts or boroughs within a city, such as Brooklyn in New York City or City of Westminster in London.

Returns:

the cityDistrict value.

getCountryRegion

public String getCountryRegion()

Get the countryRegion property: Country/region.

Returns:

the countryRegion value.

getHouse

public String getHouse()

Get the house property: Build name, such as World Trade Center.

Returns:

the house value.

getHouseNumber

public String getHouseNumber()

Get the houseNumber property: House or building number.

Returns:

the houseNumber value.

getLevel

public String getLevel()

Get the level property: Floor number, such as 3F.

Returns:

the level value.

getPoBox

public String getPoBox()

Get the poBox property: Post office box number.

Returns:

the poBox value.

getPostalCode

public String getPostalCode()

Get the postalCode property: Postal code used for mail sorting.

Returns:

the postalCode value.

getRoad

public String getRoad()

Get the road property: Street name.

Returns:

the road value.

getState

public String getState()

Get the state property: First-level administrative division.

Returns:

the state value.

getStateDistrict

public String getStateDistrict()

Get the stateDistrict property: Second-level administrative division used in certain locales.

Returns:

the stateDistrict value.

getStreetAddress

public String getStreetAddress()

Get the streetAddress property: Street-level address, excluding city, state, countryRegion, and postalCode.

Returns:

the streetAddress value.

getSuburb

public String getSuburb()

Get the suburb property: Unofficial neighborhood name, like Chinatown.

Returns:

the suburb value.

getUnit

public String getUnit()

Get the unit property: Apartment or office number.

Returns:

the unit value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to