GeoAddress

java.lang.Object
- ohos.location.GeoAddress

所有已实现的接口:

Sequenceable
```
public class GeoAddress
extends Object
implements Sequenceable
```
Represents a data class that describes geographic locations.
A geographic location consists of some parameters of an eXtensible Address Language (xAL) address, such as the longitude, latitude, country code, and administrative region name.

从以下版本开始:

1

另请参阅:

Sequenceable

嵌套类概要
- 从接口继承的嵌套类/接口 ohos.utils.Sequenceable
  Sequenceable.Producer<T>

构造器概要

构造器
构造器说明

GeoAddress(Locale locale)
Creates a GeoAddress object.

构造器
构造器	说明
`GeoAddress(Locale locale)`	Creates a `GeoAddress` object.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`void`	`clearLatitude()`	Clears the latitude information in the current `GeoAddress` object.
`void`	`clearLongitude()`	Clears the longitude information in the current `GeoAddress` object.
`String`	`getAddressUrl()`	Obtains the website URL in the current `GeoAddress` object, for example, the official website of a company.
`String`	`getAdministrativeArea()`	Obtains the administrative region name of the current `GeoAddress` object, for example, Hong Kong (China) and California.
`String`	`getCountryCode()`	Obtains the country code of the current `GeoAddress` object, for example, EN.
`String`	`getCountryName()`	Obtains the country name of the current `GeoAddress` object, for example, China.
`String`	`getDescriptions(int index)`	Obtains the description identified by a specified index.
`int`	`getDescriptionsSize()`	Obtains the total number of descriptions in the current `GeoAddress` object.
`double`	`getLatitude()`	Obtains the latitude in the current `GeoAddress` object.
`Locale`	`getLocale()`	Obtains the locale information, such as the country code, country name, and language, of the current `GeoAddress` object.
`String`	`getLocality()`	Obtains the locality of the current `GeoAddress` object, such as Beijing or New York.
`double`	`getLongitude()`	Obtains the longitude in the current `GeoAddress` object.
`String`	`getPhoneNumber()`	Obtains the phone number in the current `GeoAddress` object.
`String`	`getPlaceName()`	Obtains the landmark in the current `GeoAddress` object, for example, Eiffel Tower.
`String`	`getPostalCode()`	Obtains the postal code in the current `GeoAddress` object.
`String`	`getPremises()`	Obtains the house information in the current `GeoAddress` object, such as the house number.
`String`	`getRoadName()`	Obtains the road name in the current `GeoAddress` object.
`String`	`getSubAdministrativeArea()`	Obtains sub-administrative region name of the current `GeoAddress` object.
`String`	`getSubLocality()`	Obtains the sub-locality in the current `GeoAddress` object.
`String`	`getSubRoadName()`	Obtains auxiliary road information in the current `GeoAddress` object, for example, the road ID.
`boolean`	`hasLatitude()`	Checks whether the current `GeoAddress` object contains valid latitude information.
`boolean`	`hasLongitude()`	Checks whether the current `GeoAddress` object contains valid longitude information.
`boolean`	`marshalling(Parcel out)`	Marshalls a `GeoAddress` object into a parcel.
`void`	`setAddressUrl(String url)`	Sets the website URL of the current `GeoAddress` object.
`void`	`setAdministrativeArea(String adminArea)`	Sets the administrative region name of the current `GeoAddress` object.
`void`	`setCountryCode(String countryCode)`	Sets the country code of the current `GeoAddress` object.
`void`	`setCountryName(String countryName)`	Sets the country name of the current `GeoAddress` object.
`void`	`setDescriptions(int index, String description)`	Sets the description identified by a specified index on the address list.
`void`	`setLatitude(double latitude)`	Sets the latitude in the current `GeoAddress` object.
`void`	`setLocality(String locality)`	Sets the locality in the current `GeoAddress` object.
`void`	`setLongitude(double longitude)`	Sets the longitude in the current `GeoAddress` object.
`void`	`setPhoneNumber(String phone)`	Sets the phone number in the current `GeoAddress` object.
`void`	`setPlaceName(String placeName)`	Sets the landmark in the current `GeoAddress` object.
`void`	`setPostalCode(String postalCode)`	Sets the postal code in the current `GeoAddress` object.
`void`	`setPremises(String premises)`	Sets house information in the current `GeoAddress` object, such as the house number.
`void`	`setRoadName(String road)`	Sets the road name in the current `GeoAddress` object.
`void`	`setSubAdministrativeArea(String subAdminArea)`	Sets the sub-administrative region name of the current `GeoAddress` object.
`void`	`setSubLocality(String subLocality)`	Sets the sub-locality in the current `GeoAddress` object.
`void`	`setSubRoadName(String subRoad)`	Sets auxiliary road information in the current `GeoAddress` object, for example, the road ID.
`String`	`toString()`	Concatenates the data values of the current `GeoAddress` object into a character string.
`boolean`	`unmarshalling(Parcel in)`	Unmarshalls a `GeoAddress` object and updates its data.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 ohos.utils.Sequenceable
hasFileDescriptor

- 构造器详细资料
  - GeoAddress
```
public GeoAddress(Locale locale)
```
    Creates a GeoAddress object.
    Specifically, this method uses a Locale object as the input parameter to create a GeoAddress object. For the default values of various data fields, see the respective get method.
    
    参数:
    
    locale - Specifies the locale configuration. The value can be null if unknown.
    
    从以下版本开始:
    
    1
- 方法详细资料
  - getLocale
```
public Locale getLocale()
```
    Obtains the locale information, such as the country code, country name, and language, of the current GeoAddress object.
    
    返回:
    
    Returns the locale information of the current GeoAddress object.
    
    从以下版本开始:
    
    1
  - getDescriptionsSize
```
public int getDescriptionsSize()
```
    Obtains the total number of descriptions in the current GeoAddress object.
    A GeoAddress object may have multiple descriptions. You can use this method to obtain the total number of descriptions.
    
    返回:
    
    Returns the total number of descriptions.
    
    从以下版本开始:
    
    1
  - getDescriptions
```
public String getDescriptions(int index)
```
    Obtains the description identified by a specified index.
    Descriptions in the GeoAddress object are numbered from 0. The maximum number of descriptions is equal to the value set by getDescriptionsSize() minus 1. If the obtained index is smaller than 0 or greater than the maximum number, the value is null, indicating that no matching index has been found.
    
    参数:
    
    index - Specifies the index of the description, which must be greater than or equal to 0.
    
    返回:
    
    Returns the description identified by the specified index. The value is null if no matching description exists.
    
    从以下版本开始:
    
    1
  - setDescriptions
```
public void setDescriptions(int index,
                            String description)
                     throws IllegalArgumentException
```
    Sets the description identified by a specified index on the address list.
    Descriptions in the GeoAddress object are numbered from 0. You can modify a description identified by a specified index or append a description to the existing list. The index of the newly added description is equal to the number of descriptions obtained by getDescriptionsSize().
    
    参数:
    
    index - Specifies the index of the description. The value must be greater than or equal to 0 and less than or equal to the total number of descriptions obtained by getDescriptionsSize().
    
    description - Specifies a description. The value can be null if unknown.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the specified index is smaller than 0 or greater than the total number of descriptions obtained by getDescriptionsSize().
    
    从以下版本开始:
    
    1
  - getPlaceName
```
public String getPlaceName()
```
    Obtains the landmark in the current GeoAddress object, for example, Eiffel Tower.
    
    返回:
    
    Returns the landmark of the current GeoAddress object. The value is null if no landmark exists.
    
    从以下版本开始:
    
    1
  - setPlaceName
```
public void setPlaceName(String placeName)
```
    Sets the landmark in the current GeoAddress object.
    
    参数:
    
    placeName - Specifies the landmark. The value can be null if unknown.
    
    从以下版本开始:
    
    1
  - getAdministrativeArea
```
public String getAdministrativeArea()
```
    Obtains the administrative region name of the current GeoAddress object, for example, Hong Kong (China) and California.
    
    返回:
    
    Returns the administrative region name of the current GeoAddress object. The value is null if no administrative region name exists.
    
    从以下版本开始:
    
    1
  - setAdministrativeArea
```
public void setAdministrativeArea(String adminArea)
```
    Sets the administrative region name of the current GeoAddress object.
    
    参数:
    
    adminArea - Specifies the administrative region name. The value can be null if unknown.
    
    从以下版本开始:
    
    1
  - getSubAdministrativeArea
```
public String getSubAdministrativeArea()
```
    Obtains sub-administrative region name of the current GeoAddress object.
    
    返回:
    
    Returns the sub-administrative region name of the current GeoAddress object. The value is null if no sub-administrative region name exists.
    
    从以下版本开始:
    
    1
  - setSubAdministrativeArea
```
public void setSubAdministrativeArea(String subAdminArea)
```
    Sets the sub-administrative region name of the current GeoAddress object.
    
    参数:
    
    subAdminArea - Specifies the sub-administrative region name. The value can be null if unknown.
    
    从以下版本开始:
    
    1
  - getLocality
```
public String getLocality()
```
    Obtains the locality of the current GeoAddress object, such as Beijing or New York.
    
    返回:
    
    Returns the locality of the current GeoAddress object. The value is null if no locality exists.
    
    从以下版本开始:
    
    1
  - setLocality
```
public void setLocality(String locality)
```
    Sets the locality in the current GeoAddress object.
    
    参数:
    
    locality - Specifies the locality. The value can be null if unknown.
    
    从以下版本开始:
    
    1
  - getSubLocality
```
public String getSubLocality()
```
    Obtains the sub-locality in the current GeoAddress object.
    
    返回:
    
    Returns the sub-locality of the current GeoAddress object. The value is null if no sub-locality exists.
    
    从以下版本开始:
    
    1
  - setSubLocality
```
public void setSubLocality(String subLocality)
```
    Sets the sub-locality in the current GeoAddress object.
    
    参数:
    
    subLocality - Specifies the sub-locality. The value can be null if unknown.
    
    从以下版本开始:
    
    1
  - getRoadName
```
public String getRoadName()
```
    Obtains the road name in the current GeoAddress object.
    
    返回:
    
    Returns the road name of the current GeoAddress object. The value is null if no road name exists.
    
    从以下版本开始:
    
    1
  - setRoadName
```
public void setRoadName(String road)
```
    Sets the road name in the current GeoAddress object.
    
    参数:
    
    road - Specifies the road name. The value can be null if unknown.
    
    从以下版本开始:
    
    1
  - getSubRoadName
```
public String getSubRoadName()
```
    Obtains auxiliary road information in the current GeoAddress object, for example, the road ID.
    
    返回:
    
    Returns the auxiliary road information of the current GeoAddress object. The value is null if no auxiliary road information exists.
    
    从以下版本开始:
    
    1
  - setSubRoadName
```
public void setSubRoadName(String subRoad)
```
    Sets auxiliary road information in the current GeoAddress object, for example, the road ID.
    
    参数:
    
    subRoad - Specifies the auxiliary road information. The value can be null if unknown.
    
    从以下版本开始:
    
    1
  - getPremises
```
public String getPremises()
```
    Obtains the house information in the current GeoAddress object, such as the house number.
    
    返回:
    
    Returns the house information of the current GeoAddress object. The value is null if no house information exists.
    
    从以下版本开始:
    
    1
  - setPremises
```
public void setPremises(String premises)
```
    Sets house information in the current GeoAddress object, such as the house number.
    
    参数:
    
    premises - Specifies the house information. The value can be null if unknown.
    
    从以下版本开始:
    
    1
  - getPostalCode
```
public String getPostalCode()
```
    Obtains the postal code in the current GeoAddress object.
    
    返回:
    
    Returns the postal code of the current GeoAddress object. The value is null if no postal code exists.
    
    从以下版本开始:
    
    1
  - setPostalCode
```
public void setPostalCode(String postalCode)
```
    Sets the postal code in the current GeoAddress object.
    
    参数:
    
    postalCode - Specifies the postal code. The value can be null if unknown.
    
    从以下版本开始:
    
    1
  - getCountryCode
```
public String getCountryCode()
```
    Obtains the country code of the current GeoAddress object, for example, EN.
    
    返回:
    
    Returns the country code of the current GeoAddress object. The value is null if no country code exists.
    
    从以下版本开始:
    
    1
  - setCountryCode
```
public void setCountryCode(String countryCode)
```
    Sets the country code of the current GeoAddress object.
    
    参数:
    
    countryCode - Specifies the country code. The value can be null if unknown.
    
    从以下版本开始:
    
    1
  - getCountryName
```
public String getCountryName()
```
    Obtains the country name of the current GeoAddress object, for example, China.
    
    返回:
    
    Returns the country name of the current GeoAddress object. The value is null if no country name exists.
    
    从以下版本开始:
    
    1
  - setCountryName
```
public void setCountryName(String countryName)
```
    Sets the country name of the current GeoAddress object.
    
    参数:
    
    countryName - Specifies the country name. It can be null if unknown.
    
    从以下版本开始:
    
    1
  - hasLatitude
```
public boolean hasLatitude()
```
    Checks whether the current GeoAddress object contains valid latitude information.
    
    返回:
    
    Returns true if the current GeoAddress object contains valid latitude information; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getLatitude
```
public double getLatitude()
```
    Obtains the latitude in the current GeoAddress object.
    
    返回:
    
    Returns the latitude of the current GeoAddress object. The default value is 0.0.
    
    从以下版本开始:
    
    1
  - setLatitude
```
public void setLatitude(double latitude)
                 throws IllegalArgumentException
```
    Sets the latitude in the current GeoAddress object.
    
    参数:
    
    latitude - Specifies the latitude. The value range is [-90,90], in unit of degrees.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the latitude is not within the range [-90,90].
    
    从以下版本开始:
    
    1
  - clearLatitude
```
public void clearLatitude()
```
    Clears the latitude information in the current GeoAddress object.
    
    从以下版本开始:
    
    1
  - hasLongitude
```
public boolean hasLongitude()
```
    Checks whether the current GeoAddress object contains valid longitude information.
    
    返回:
    
    Returns true if the current GeoAddress object contains valid longitude information; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getLongitude
```
public double getLongitude()
```
    Obtains the longitude in the current GeoAddress object.
    
    返回:
    
    Returns the longitude of the current GeoAddress object. The default value is 0.0.
    
    从以下版本开始:
    
    1
  - setLongitude
```
public void setLongitude(double longitude)
                  throws IllegalArgumentException
```
    Sets the longitude in the current GeoAddress object.
    
    参数:
    
    longitude - Specifies the longitude. The value range is [-180,180], in unit of degrees.
    
    抛出:
    
    IllegalArgumentException - Throws this exception if the longitude is not within the range [-180,180].
    
    从以下版本开始:
    
    1
  - clearLongitude
```
public void clearLongitude()
```
    Clears the longitude information in the current GeoAddress object.
    
    从以下版本开始:
    
    1
  - getPhoneNumber
```
public String getPhoneNumber()
```
    Obtains the phone number in the current GeoAddress object.
    
    返回:
    
    Returns the phone number of the current GeoAddress object. The value is null if no phone number exists.
    
    从以下版本开始:
    
    1
  - setPhoneNumber
```
public void setPhoneNumber(String phone)
```
    Sets the phone number in the current GeoAddress object.
    
    参数:
    
    phone - Specifies the phone number. The value can be null if unknown.
    
    从以下版本开始:
    
    1
  - getAddressUrl
```
public String getAddressUrl()
```
    Obtains the website URL in the current GeoAddress object, for example, the official website of a company.
    
    返回:
    
    Returns the website URL of the current GeoAddress object. The value is null if no website URL exists.
    
    从以下版本开始:
    
    1
  - setAddressUrl
```
public void setAddressUrl(String url)
```
    Sets the website URL of the current GeoAddress object.
    
    参数:
    
    url - Specifies the website URL. The value can be null if unknown.
    
    从以下版本开始:
    
    1
  - toString
```
public String toString()
```
    Concatenates the data values of the current GeoAddress object into a character string.
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    Returns a character string containing the concatenated data values.
    
    从以下版本开始:
    
    1
  - unmarshalling
```
public boolean unmarshalling(Parcel in)
```
    Unmarshalls a GeoAddress object and updates its data.
    Unmarshalling of GeoAddress objects is implemented using Sequenceable.
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    in - Specifies the Parcel object for unmarshalling a GeoAddress object. The value must not be null.
    
    返回:
    
    Returns true if unmarshaling is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    Parcel, Sequenceable
  - marshalling
```
public boolean marshalling(Parcel out)
```
    Marshalls a GeoAddress object into a parcel.
    Marshalling of GeoAddress objects is implemented using Sequenceable.
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    out - Specifies the Parcel object for marshalling a GeoAddress object. The value must not be null.
    
    返回:
    
    Returns true if marshaling is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    Parcel, Sequenceable

类 GeoAddress

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 ohos.utils.Sequenceable

构造器详细资料

GeoAddress

方法详细资料

getLocale

getDescriptionsSize

getDescriptions

setDescriptions

getPlaceName

setPlaceName

getAdministrativeArea

setAdministrativeArea

getSubAdministrativeArea

setSubAdministrativeArea

getLocality

setLocality

getSubLocality

setSubLocality

getRoadName

setRoadName

getSubRoadName

setSubRoadName

getPremises

setPremises

getPostalCode

setPostalCode

getCountryCode

setCountryCode

getCountryName

setCountryName

hasLatitude

getLatitude

setLatitude

clearLatitude

hasLongitude

getLongitude

setLongitude

clearLongitude

getPhoneNumber

setPhoneNumber

getAddressUrl

setAddressUrl

toString

unmarshalling

marshalling