PostalAddress

public abstract class PostalAddress implements Parcelable

Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains.

Summary

Nested types
public abstract class PostalAddress.Builder

A builder to create instances of PostalAddress.

Public constructors

Public methods
static PostalAddress.Builder
builder(String regionCode)

Returns a new instance of Builder.
abstract @Nullable List<String>

Unstructured address lines describing the lower levels of an address.
abstract @Nullable String

Highest administrative subdivision which is used for postal addresses of a country or region.
abstract @Nullable String

BCP-47 language code of the contents of this address.
abstract @Nullable String

Generally refers to the city or town portion of the address.
abstract @Nullable String

The name of the organization at the address.
abstract @Nullable String

Postal code of the address.
abstract @Nullable List<String>

The recipient at the address.
abstract String

CLDR region code of the country/region of the address.
abstract @Nullable String

Additional, country-specific, sorting code.
abstract @Nullable String

Sublocality of the address.

Inherited Constants
From android.os.Parcelable
static final int
static final int
static final int
static final int

Inherited methods
From android.os.Parcelable
abstract int
int
abstract void
writeToParcel(Parcel p, int p1)

Public constructors

PostalAddress

public PostalAddress()

Public methods

builder

public static PostalAddress.Builder builder(String regionCode)

Returns a new instance of Builder.

getAddressLines

public abstract @Nullable List<String> getAddressLines()

Unstructured address lines describing the lower levels of an address.

Because values in "address lines" do not have type information and may sometimes contain multiple values in a single field, for example, "Austin, TX", it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary, for example, Japan, "language code" is used to make it explicit, for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large. In this way, the most specific line of an address can be selected based on the language.

The minimum permitted structural representation of an address consists of a "region code" with all remaining information placed in the "address lines". It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved.

Creating an address only containing a "region code" and "address lines" and then geocoding is the recommended way to handle completely unstructured addresses, as opposed to guessing which parts of the address should be localities or administrative areas.

getAdministrativeArea

public abstract @Nullable String getAdministrativeArea()

Highest administrative subdivision which is used for postal addresses of a country or region.

For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community, for example, "Barcelona" and not "Catalonia". Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.

getLanguageCode

public abstract @Nullable String getLanguageCode()

BCP-47 language code of the contents of this address.

This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations.

If this value is not known, it should be omitted rather than specifying a possibly incorrect default.

Examples: "zh-Hant", "ja", "ja-Latn", "en".

getLocality

public abstract @Nullable String getLocality()

Generally refers to the city or town portion of the address.

Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave "locality" empty and use "address lines".

getOrganization

public abstract @Nullable String getOrganization()

The name of the organization at the address.

getPostalCode

public abstract @Nullable String getPostalCode()

Postal code of the address.

Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address, for example, state or zip code validation in the United States.

getRecipients

public abstract @Nullable List<String> getRecipients()

The recipient at the address.

This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

getRegionCode

public abstract String getRegionCode()

CLDR region code of the country/region of the address.

getSortingCode

public abstract @Nullable String getSortingCode()

Additional, country-specific, sorting code.

This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number, for example, "CEDEX 7", or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).

getSublocality

public abstract @Nullable String getSublocality()

Sublocality of the address.

For example, this can be a neighborhood, borough, or district.