public class

Address

extends Object
implements Parcelable
java.lang.Object
   ↳ android.location.Address

Class Overview

A class representing an Address, i.e, a set of Strings describing a location. The addres format is a simplified version of xAL (eXtensible Address Language) http://www.oasis-open.org/committees/ciq/ciq.html#6

Summary

Constants
Creator<Address> CREATOR
[Expand]
Inherited Constants
From interface android.os.Parcelable
Public Constructors
Address(Locale locale)
Constructs a new Address object set to the given Locale and with all other fields initialized to null or false.
Public Methods
void clearLatitude()
Removes any latitude associated with this address.
void clearLongitude()
Removes any longitude associated with this address.
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
String getAddressLine(int index)
Returns a line of the address numbered by the given index (starting at 0), or null if no such line is present.
String getAdminArea()
Returns the administrative area name of the address, for example, "CA", or null if it is unknown
String getCountryCode()
Returns the country code of the address, for example "US", or null if it is unknown.
String getCountryName()
Returns the localized country name of the address, for example "Iceland", or null if it is unknown.
Bundle getExtras()
Returns additional provider-specific information about the address as a Bundle.
String getFeatureName()
Returns the feature name of the address, for example, "Golden Gate Bridge", or null if it is unknown
double getLatitude()
Returns the latitude of the address if known.
Locale getLocale()
Returns the Locale associated with this address.
String getLocality()
Returns the locality of the address, for example "Mountain View", or null if it is unknown.
double getLongitude()
Returns the longitude of the address if known.
int getMaxAddressLineIndex()
Returns the largest index currently in use to specify an address line.
String getPhone()
Returns the phone number of the address if known, or null if it is unknown.
String getPostalCode()
Returns the postal code of the address, for example "94110", or null if it is unknown.
String getSubAdminArea()
Returns the sub-administrative area name of the address, for example, "Santa Clara County", or null if it is unknown
String getThoroughfare()
Returns the thoroughfare name of the address, for example, "1600 Ampitheater Parkway", which may be null
String getUrl()
Returns the public URL for the address if known, or null if it is unknown.
boolean hasLatitude()
Returns true if a latitude has been assigned to this Address, false otherwise.
boolean hasLongitude()
Returns true if a longitude has been assigned to this Address, false otherwise.
void setAddressLine(int index, String line)
Sets the line of the address numbered by index (starting at 0) to the given String, which may be null.
void setAdminArea(String adminArea)
Sets the administrative area name of the address to the given String, which may be null
void setCountryCode(String countryCode)
Sets the country code of the address to the given String, which may be null.
void setCountryName(String countryName)
Sets the country name of the address to the given String, which may be null.
void setExtras(Bundle extras)
Sets the extra information associated with this fix to the given Bundle.
void setFeatureName(String featureName)
Sets the feature name of the address to the given String, which may be null
void setLatitude(double latitude)
Sets the latitude associated with this address.
void setLocality(String locality)
Sets the locality of the address to the given String, which may be null.
void setLongitude(double longitude)
Sets the longitude associated with this address.
void setPhone(String phone)
Sets the phone number associated with this address.
void setPostalCode(String postalCode)
Sets the postal code of the address to the given String, which may be null.
void setSubAdminArea(String subAdminArea)
Sets the sub-administrative area name of the address to the given String, which may be null
void setThoroughfare(String thoroughfare)
Sets the thoroughfare name of the address, which may be null.
void setUrl(String Url)
Sets the public URL associated with this address.
String toString()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel(Parcel parcel, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Constants

public static final Creator<Address> CREATOR

Public Constructors

public Address (Locale locale)

Constructs a new Address object set to the given Locale and with all other fields initialized to null or false.

Public Methods

public void clearLatitude ()

Removes any latitude associated with this address.

public void clearLongitude ()

Removes any longitude associated with this address.

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public String getAddressLine (int index)

Returns a line of the address numbered by the given index (starting at 0), or null if no such line is present.

Throws
IllegalArgumentException if index < 0

public String getAdminArea ()

Returns the administrative area name of the address, for example, "CA", or null if it is unknown

public String getCountryCode ()

Returns the country code of the address, for example "US", or null if it is unknown.

public String getCountryName ()

Returns the localized country name of the address, for example "Iceland", or null if it is unknown.

public Bundle getExtras ()

Returns additional provider-specific information about the address as a Bundle. The keys and values are determined by the provider. If no additional information is available, null is returned.

public String getFeatureName ()

Returns the feature name of the address, for example, "Golden Gate Bridge", or null if it is unknown

public double getLatitude ()

Returns the latitude of the address if known.

Throws
IllegalStateException if this Address has not been assigned a latitude.

public Locale getLocale ()

Returns the Locale associated with this address.

public String getLocality ()

Returns the locality of the address, for example "Mountain View", or null if it is unknown.

public double getLongitude ()

Returns the longitude of the address if known.

Throws
IllegalStateException if this Address has not been assigned a longitude.

public int getMaxAddressLineIndex ()

Returns the largest index currently in use to specify an address line. If no address lines are specified, -1 is returned.

public String getPhone ()

Returns the phone number of the address if known, or null if it is unknown.

Throws
IllegalStateException if this Address has not been assigned a latitude.

public String getPostalCode ()

Returns the postal code of the address, for example "94110", or null if it is unknown.

public String getSubAdminArea ()

Returns the sub-administrative area name of the address, for example, "Santa Clara County", or null if it is unknown

public String getThoroughfare ()

Returns the thoroughfare name of the address, for example, "1600 Ampitheater Parkway", which may be null

public String getUrl ()

Returns the public URL for the address if known, or null if it is unknown.

public boolean hasLatitude ()

Returns true if a latitude has been assigned to this Address, false otherwise.

public boolean hasLongitude ()

Returns true if a longitude has been assigned to this Address, false otherwise.

public void setAddressLine (int index, String line)

Sets the line of the address numbered by index (starting at 0) to the given String, which may be null.

Throws
IllegalArgumentException if index < 0

public void setAdminArea (String adminArea)

Sets the administrative area name of the address to the given String, which may be null

public void setCountryCode (String countryCode)

Sets the country code of the address to the given String, which may be null.

public void setCountryName (String countryName)

Sets the country name of the address to the given String, which may be null.

public void setExtras (Bundle extras)

Sets the extra information associated with this fix to the given Bundle.

public void setFeatureName (String featureName)

Sets the feature name of the address to the given String, which may be null

public void setLatitude (double latitude)

Sets the latitude associated with this address.

public void setLocality (String locality)

Sets the locality of the address to the given String, which may be null.

public void setLongitude (double longitude)

Sets the longitude associated with this address.

public void setPhone (String phone)

Sets the phone number associated with this address.

public void setPostalCode (String postalCode)

Sets the postal code of the address to the given String, which may be null.

public void setSubAdminArea (String subAdminArea)

Sets the sub-administrative area name of the address to the given String, which may be null

public void setThoroughfare (String thoroughfare)

Sets the thoroughfare name of the address, which may be null.

public void setUrl (String Url)

Sets the public URL associated with this address.

public String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation simply concatenates the class name, the '@' sign and a hexadecimal representation of the object's hashCode(), that is, it is equivalent to the following expression: 

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
  • a printable representation of this object.

public void writeToParcel (Parcel parcel, int flags)

Flatten this object in to a Parcel.

Parameters
parcel The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.