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 administrativeDistrictLevel1, String postalCode, String country) 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	getCountry() Getter for Country.
String	getLocality() Getter for Locality.
String	getPostalCode() Getter for PostalCode.
String	getSublocality() Getter for Sublocality.
int	hashCode()
Address.Builder	toBuilder() Builds a new Address.Builder object.
String	toString() Converts this Address into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Address

public Address(String addressLine1,
               String addressLine2,
               String addressLine3,
               String locality,
               String sublocality,
               String administrativeDistrictLevel1,
               String postalCode,
               String country)

Initialization constructor.

Parameters:

addressLine1 - String value for addressLine1.

addressLine2 - String value for addressLine2.

addressLine3 - String value for addressLine3.

locality - String value for locality.

sublocality - String value for sublocality.

administrativeDistrictLevel1 - String value for administrativeDistrictLevel1.

postalCode - String value for postalCode.

country - String value for country.

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).

Returns:

Returns the String

getAddressLine2

public String getAddressLine2()

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

Returns:

Returns the String

getAddressLine3

public String getAddressLine3()

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

Returns:

Returns the String

getLocality

public String getLocality()

Getter for Locality. The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).

Returns:

Returns the String

getSublocality

public String getSublocality()

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

Returns:

Returns the String

getAdministrativeDistrictLevel1

public String getAdministrativeDistrictLevel1()

Getter for AdministrativeDistrictLevel1. A civil entity within the address's country. In the US, this is the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).

Returns:

Returns the String

getPostalCode

public String getPostalCode()

Getter for PostalCode. The address's postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).

Returns:

Returns the String

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).

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this Address into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

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