Skip to content

Most visited

Recently visited

navigation
Added in API level 1

Address

public class Address
extends Object implements Parcelable

java.lang.Object
   ↳ android.location.Address


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

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<Address> CREATOR

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 instance's marshaled 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 getPremises()

Returns the premises of the address, 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 getSubLocality()

Returns the sub-locality of the address, or null if it is unknown.

String getSubThoroughfare()

Returns the sub-thoroughfare name of the address, which may be null.

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 setPremises(String premises)

Sets the premises 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 setSubLocality(String sublocality)

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

void setSubThoroughfare(String subthoroughfare)

Sets the sub-thoroughfare name of the address, 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 representation of the object.

void writeToParcel(Parcel parcel, int flags)

Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Fields

CREATOR

Added in API level 1
Creator<Address> CREATOR

Public constructors

Address

Added in API level 1
Address (Locale locale)

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

Parameters
locale Locale

Public methods

clearLatitude

Added in API level 1
void clearLatitude ()

Removes any latitude associated with this address.

clearLongitude

Added in API level 1
void clearLongitude ()

Removes any longitude associated with this address.

describeContents

Added in API level 1
int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

getAddressLine

Added in API level 1
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.

Parameters
index int
Returns
String
Throws
IllegalArgumentException if index < 0

getAdminArea

Added in API level 1
String getAdminArea ()

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

Returns
String

getCountryCode

Added in API level 1
String getCountryCode ()

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

Returns
String

getCountryName

Added in API level 1
String getCountryName ()

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

Returns
String

getExtras

Added in API level 1
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.

Returns
Bundle

getFeatureName

Added in API level 1
String getFeatureName ()

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

Returns
String

getLatitude

Added in API level 1
double getLatitude ()

Returns the latitude of the address if known.

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

getLocale

Added in API level 1
Locale getLocale ()

Returns the Locale associated with this address.

Returns
Locale

getLocality

Added in API level 1
String getLocality ()

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

Returns
String

getLongitude

Added in API level 1
double getLongitude ()

Returns the longitude of the address if known.

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

getMaxAddressLineIndex

Added in API level 1
int getMaxAddressLineIndex ()

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

Returns
int

getPhone

Added in API level 1
String getPhone ()

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

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

getPostalCode

Added in API level 1
String getPostalCode ()

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

Returns
String

getPremises

Added in API level 4
String getPremises ()

Returns the premises of the address, or null if it is unknown.

Returns
String

getSubAdminArea

Added in API level 1
String getSubAdminArea ()

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

Returns
String

getSubLocality

Added in API level 4
String getSubLocality ()

Returns the sub-locality of the address, or null if it is unknown. For example, this may correspond to the neighborhood of the locality.

Returns
String

getSubThoroughfare

Added in API level 4
String getSubThoroughfare ()

Returns the sub-thoroughfare name of the address, which may be null. This may correspond to the street number of the address.

Returns
String

getThoroughfare

Added in API level 1
String getThoroughfare ()

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

Returns
String

getUrl

Added in API level 1
String getUrl ()

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

Returns
String

hasLatitude

Added in API level 1
boolean hasLatitude ()

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

Returns
boolean

hasLongitude

Added in API level 1
boolean hasLongitude ()

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

Returns
boolean

setAddressLine

Added in API level 1
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.

Parameters
index int
line String
Throws
IllegalArgumentException if index < 0

setAdminArea

Added in API level 1
void setAdminArea (String adminArea)

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

Parameters
adminArea String

setCountryCode

Added in API level 1
void setCountryCode (String countryCode)

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

Parameters
countryCode String

setCountryName

Added in API level 1
void setCountryName (String countryName)

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

Parameters
countryName String

setExtras

Added in API level 1
void setExtras (Bundle extras)

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

Parameters
extras Bundle

setFeatureName

Added in API level 1
void setFeatureName (String featureName)

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

Parameters
featureName String

setLatitude

Added in API level 1
void setLatitude (double latitude)

Sets the latitude associated with this address.

Parameters
latitude double

setLocality

Added in API level 1
void setLocality (String locality)

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

Parameters
locality String

setLongitude

Added in API level 1
void setLongitude (double longitude)

Sets the longitude associated with this address.

Parameters
longitude double

setPhone

Added in API level 1
void setPhone (String phone)

Sets the phone number associated with this address.

Parameters
phone String

setPostalCode

Added in API level 1
void setPostalCode (String postalCode)

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

Parameters
postalCode String

setPremises

Added in API level 4
void setPremises (String premises)

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

Parameters
premises String

setSubAdminArea

Added in API level 1
void setSubAdminArea (String subAdminArea)

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

Parameters
subAdminArea String

setSubLocality

Added in API level 4
void setSubLocality (String sublocality)

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

Parameters
sublocality String

setSubThoroughfare

Added in API level 4
void setSubThoroughfare (String subthoroughfare)

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

Parameters
subthoroughfare String

setThoroughfare

Added in API level 1
void setThoroughfare (String thoroughfare)

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

Parameters
thoroughfare String

setUrl

Added in API level 1
void setUrl (String Url)

Sets the public URL associated with this address.

Parameters
Url String

toString

Added in API level 1
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

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

Returns
String a string representation of the object.

writeToParcel

Added in API level 1
void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
parcel Parcel: The Parcel in which the object should be written.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.