com.squareup.square.models

Class Address

java.lang.Object

com.squareup.square.models.Address

public class Address
extends Object

This is a model class for Address type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Address.Builder Class to build instances of Address

Constructor Summary

Constructors

Constructor and Description
Address(String addressLine1, String addressLine2, String addressLine3, String locality, String sublocality, String sublocality2, String sublocality3, String administrativeDistrictLevel1, String administrativeDistrictLevel2, String administrativeDistrictLevel3, String postalCode, String country, String firstName, String lastName, String organization) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAddressLine1() Getter for AddressLine1.
String	getAddressLine2() Getter for AddressLine2.
String	getAddressLine3() Getter for AddressLine3.
String	getAdministrativeDistrictLevel1() Getter for AdministrativeDistrictLevel1.
String	getAdministrativeDistrictLevel2() Getter for AdministrativeDistrictLevel2.
String	getAdministrativeDistrictLevel3() Getter for AdministrativeDistrictLevel3.
String	getCountry() Getter for Country.
String	getFirstName() Getter for FirstName.
String	getLastName() Getter for LastName.
String	getLocality() Getter for Locality.
String	getOrganization() Getter for Organization.
String	getPostalCode() Getter for PostalCode.
String	getSublocality() Getter for Sublocality.
String	getSublocality2() Getter for Sublocality2.
String	getSublocality3() Getter for Sublocality3.
int	hashCode()
Address.Builder	toBuilder() Builds a new Address.Builder object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Address

public Address(String addressLine1,
               String addressLine2,
               String addressLine3,
               String locality,
               String sublocality,
               String sublocality2,
               String sublocality3,
               String administrativeDistrictLevel1,
               String administrativeDistrictLevel2,
               String administrativeDistrictLevel3,
               String postalCode,
               String country,
               String firstName,
               String lastName,
               String organization)

Initialization constructor.

Parameters:

addressLine1 -

addressLine2 -

addressLine3 -

locality -

sublocality -

sublocality2 -

sublocality3 -

administrativeDistrictLevel1 -

administrativeDistrictLevel2 -

administrativeDistrictLevel3 -

postalCode -

country -

firstName -

lastName -

organization -

Method Detail

getAddressLine1

public String getAddressLine1()

Getter for AddressLine1. The first line of the address. Fields that start with `address_line` provide the address's most specific details, like street number, street name, and building name. They do *not* provide less specific details like city, state/province, or country (these details are provided in other fields).

getAddressLine2

public String getAddressLine2()

Getter for AddressLine2. The second line of the address, if any.

getAddressLine3

public String getAddressLine3()

Getter for AddressLine3. The third line of the address, if any.

getLocality

public String getLocality()

Getter for Locality. The city or town of the address.

getSublocality

public String getSublocality()

Getter for Sublocality. A civil region within the address's `locality`, if any.

getSublocality2

public String getSublocality2()

Getter for Sublocality2. A civil region within the address's `sublocality`, if any.

getSublocality3

public String getSublocality3()

Getter for Sublocality3. A civil region within the address's `sublocality_2`, if any.

getAdministrativeDistrictLevel1

public String getAdministrativeDistrictLevel1()

Getter for AdministrativeDistrictLevel1. A civil entity within the address's country. In the US, this is the state.

getAdministrativeDistrictLevel2

public String getAdministrativeDistrictLevel2()

Getter for AdministrativeDistrictLevel2. A civil entity within the address's `administrative_district_level_1`. In the US, this is the county.

getAdministrativeDistrictLevel3

public String getAdministrativeDistrictLevel3()

Getter for AdministrativeDistrictLevel3. A civil entity within the address's `administrative_district_level_2`, if any.

getPostalCode

public String getPostalCode()

Getter for PostalCode. The address's postal code.

getCountry

public String getCountry()

Getter for Country. Indicates the country associated with another entity, such as a business. Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).

getFirstName

public String getFirstName()

Getter for FirstName. Optional first name when it's representing recipient.

getLastName

public String getLastName()

Getter for LastName. Optional last name when it's representing recipient.

getOrganization

public String getOrganization()

Getter for Organization. Optional organization name when it's representing recipient.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toBuilder

public Address.Builder toBuilder()

Builds a new Address.Builder object. Creates the instance with the state of the current model.

Returns:

a new Address.Builder object