Class PostalAddress (2.44.0) 

public final class PostalAddress extends GeneratedMessageV3 implements PostalAddressOrBuilder

Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains).

In typical usage an address would be created via user input or from importing existing data, depending on the type of process.

Advice on address input / editing:

Protobuf type google.type.PostalAddress

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PostalAddress

Static Fields

ADDRESS_LINES_FIELD_NUMBER

public static final int ADDRESS_LINES_FIELD_NUMBER
Field Value
Type Description
int

ADMINISTRATIVE_AREA_FIELD_NUMBER

public static final int ADMINISTRATIVE_AREA_FIELD_NUMBER
Field Value
Type Description
int

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value
Type Description
int

LOCALITY_FIELD_NUMBER

public static final int LOCALITY_FIELD_NUMBER
Field Value
Type Description
int

ORGANIZATION_FIELD_NUMBER

public static final int ORGANIZATION_FIELD_NUMBER
Field Value
Type Description
int

POSTAL_CODE_FIELD_NUMBER

public static final int POSTAL_CODE_FIELD_NUMBER
Field Value
Type Description
int

RECIPIENTS_FIELD_NUMBER

public static final int RECIPIENTS_FIELD_NUMBER
Field Value
Type Description
int

REGION_CODE_FIELD_NUMBER

public static final int REGION_CODE_FIELD_NUMBER
Field Value
Type Description
int

REVISION_FIELD_NUMBER

public static final int REVISION_FIELD_NUMBER
Field Value
Type Description
int

SORTING_CODE_FIELD_NUMBER

public static final int SORTING_CODE_FIELD_NUMBER
Field Value
Type Description
int

SUBLOCALITY_FIELD_NUMBER

public static final int SUBLOCALITY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PostalAddress getDefaultInstance()
Returns
Type Description
PostalAddress

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PostalAddress.Builder newBuilder()
Returns
Type Description
PostalAddress.Builder

newBuilder(PostalAddress prototype)

public static PostalAddress.Builder newBuilder(PostalAddress prototype)
Parameter
Name Description
prototype PostalAddress
Returns
Type Description
PostalAddress.Builder

parseDelimitedFrom(InputStream input)

public static PostalAddress parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PostalAddress
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PostalAddress parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PostalAddress
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PostalAddress parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PostalAddress
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PostalAddress parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PostalAddress
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PostalAddress parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PostalAddress
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PostalAddress parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PostalAddress
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PostalAddress parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PostalAddress
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PostalAddress parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PostalAddress
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PostalAddress parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PostalAddress
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PostalAddress parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PostalAddress
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PostalAddress parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PostalAddress
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PostalAddress parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PostalAddress
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PostalAddress> parser()
Returns
Type Description
Parser<PostalAddress>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAddressLines(int index)

public String getAddressLines(int index)

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 (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). 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).

repeated string address_lines = 9;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The addressLines at the given index.

getAddressLinesBytes(int index)

public ByteString getAddressLinesBytes(int index)

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 (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). 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).

repeated string address_lines = 9;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the addressLines at the given index.

getAddressLinesCount()

public int getAddressLinesCount()

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 (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). 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).

repeated string address_lines = 9;

Returns
Type Description
int

The count of addressLines.

getAddressLinesList()

public ProtocolStringList getAddressLinesList()

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 (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). 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).

repeated string address_lines = 9;

Returns
Type Description
ProtocolStringList

A list containing the addressLines.

getAdministrativeArea()

public String getAdministrativeArea()

Optional. 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. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

string administrative_area = 6;

Returns
Type Description
String

The administrativeArea.

getAdministrativeAreaBytes()

public ByteString getAdministrativeAreaBytes()

Optional. 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. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

string administrative_area = 6;

Returns
Type Description
ByteString

The bytes for administrativeArea.

getDefaultInstanceForType()

public PostalAddress getDefaultInstanceForType()
Returns
Type Description
PostalAddress

getLanguageCode()

public String getLanguageCode()

Optional. BCP-47 language code of the contents of this address (if known). 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".

string language_code = 3;

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

Optional. BCP-47 language code of the contents of this address (if known). 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".

string language_code = 3;

Returns
Type Description
ByteString

The bytes for languageCode.

getLocality()

public String getLocality()

Optional. Generally refers to the city/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.

string locality = 7;

Returns
Type Description
String

The locality.

getLocalityBytes()

public ByteString getLocalityBytes()

Optional. Generally refers to the city/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.

string locality = 7;

Returns
Type Description
ByteString

The bytes for locality.

getOrganization()

public String getOrganization()

Optional. The name of the organization at the address.

string organization = 11;

Returns
Type Description
String

The organization.

getOrganizationBytes()

public ByteString getOrganizationBytes()

Optional. The name of the organization at the address.

string organization = 11;

Returns
Type Description
ByteString

The bytes for organization.

getParserForType()

public Parser<PostalAddress> getParserForType()
Returns
Type Description
Parser<PostalAddress>
Overrides

getPostalCode()

public String getPostalCode()

Optional. 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 (e.g. state/zip validation in the U.S.A.).

string postal_code = 4;

Returns
Type Description
String

The postalCode.

getPostalCodeBytes()

public ByteString getPostalCodeBytes()

Optional. 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 (e.g. state/zip validation in the U.S.A.).

string postal_code = 4;

Returns
Type Description
ByteString

The bytes for postalCode.

getRecipients(int index)

public String getRecipients(int index)

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

repeated string recipients = 10;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The recipients at the given index.

getRecipientsBytes(int index)

public ByteString getRecipientsBytes(int index)

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

repeated string recipients = 10;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the recipients at the given index.

getRecipientsCount()

public int getRecipientsCount()

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

repeated string recipients = 10;

Returns
Type Description
int

The count of recipients.

getRecipientsList()

public ProtocolStringList getRecipientsList()

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

repeated string recipients = 10;

Returns
Type Description
ProtocolStringList

A list containing the recipients.

getRegionCode()

public String getRegionCode()

Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

string region_code = 2;

Returns
Type Description
String

The regionCode.

getRegionCodeBytes()

public ByteString getRegionCodeBytes()

Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

string region_code = 2;

Returns
Type Description
ByteString

The bytes for regionCode.

getRevision()

public int getRevision()

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision.

All new revisions must be backward compatible with old revisions.

int32 revision = 1;

Returns
Type Description
int

The revision.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSortingCode()

public String getSortingCode()

Optional. 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 (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

string sorting_code = 5;

Returns
Type Description
String

The sortingCode.

getSortingCodeBytes()

public ByteString getSortingCodeBytes()

Optional. 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 (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

string sorting_code = 5;

Returns
Type Description
ByteString

The bytes for sortingCode.

getSublocality()

public String getSublocality()

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

string sublocality = 8;

Returns
Type Description
String

The sublocality.

getSublocalityBytes()

public ByteString getSublocalityBytes()

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

string sublocality = 8;

Returns
Type Description
ByteString

The bytes for sublocality.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PostalAddress.Builder newBuilderForType()
Returns
Type Description
PostalAddress.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PostalAddress.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PostalAddress.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PostalAddress.Builder toBuilder()
Returns
Type Description
PostalAddress.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException