com.blockscore.models

Class Address

java.lang.Object

com.blockscore.models.Address

public class Address
extends java.lang.Object

The address model.

Constructor Summary

Constructors

Constructor and Description
Address()
Address(java.lang.String street1, java.lang.String street2, java.lang.String city, java.lang.String subdivision, java.lang.String postalCode, java.lang.String countryCode) Constructs a new Address object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCity() The city name of the customer.
java.lang.String	getCountryCode() The country of the customer.
java.lang.String	getPostalCode() The postal code, also known as the ZIP code of the address.
java.lang.String	getStreet1() Gets the primary street address of the customer.
java.lang.String	getStreet2() The second address line typically used for apartment or suite numbers.
java.lang.String	getSubdivision() The subdivision of the entered country.
Address	setCity(java.lang.String city) The city name of the customer.
Address	setCountryCode(java.lang.String countryCode) The country of the customer.
Address	setPostalCode(java.lang.String postalCode) The postal code, also known as the ZIP code of the address.
Address	setStreet1(java.lang.String street1) The primary street address of the customer.
Address	setStreet2(java.lang.String street2) The second address line typically used for apartment or suite numbers.
Address	setSubdivision(java.lang.String subdivision) The subdivision of the entered country.

Methods inherited from class java.lang.Object

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

Constructor Detail

Address

public Address()

Address

public Address(java.lang.String street1,
               java.lang.String street2,
               java.lang.String city,
               java.lang.String subdivision,
               java.lang.String postalCode,
               java.lang.String countryCode)

Constructs a new Address object.

Parameters:

street1 - the primary street address

street2 - the second address line (typically for apartment or suite numbers)

city - the city

subdivision - the subdivision of the entered country (in the U.S., the state)

postalCode - the postal (ZIP) code

countryCode - the country code

Method Detail

setStreet1

@NotNull
public Address setStreet1(java.lang.String street1)

The primary street address of the customer. This is automatically normalized.

Parameters:

street1 - Street (Line 1)

Returns:

this

setStreet2

@NotNull
public Address setStreet2(java.lang.String street2)

The second address line typically used for apartment or suite numbers. This is automatically normalized.

Parameters:

street2 - Street (Line 2)

Returns:

this

setCity

@NotNull
public Address setCity(java.lang.String city)

The city name of the customer. This is automatically normalized.

Parameters:

city - City

Returns:

this

setSubdivision

@NotNull
public Address setSubdivision(java.lang.String subdivision)

The subdivision of the entered country. For instance in the United States, this would be a 'state'. Ex: The subdivision for California would be CA.

Parameters:

subdivision - Subdivision (FIPS code format)

Returns:

this

setPostalCode

@NotNull
public Address setPostalCode(java.lang.String postalCode)

The postal code, also known as the ZIP code of the address.

Parameters:

postalCode - Postal (ZIP) code

Returns:

this

setCountryCode

@NotNull
public Address setCountryCode(java.lang.String countryCode)

The country of the customer. Should be of the ISO code form.

Parameters:

countryCode - the country code

Returns:

this

getStreet1

public java.lang.String getStreet1()

Gets the primary street address of the customer. This is automatically normalized.

Returns:

Line 1 of the address

getStreet2

public java.lang.String getStreet2()

The second address line typically used for apartment or suite numbers. This is automatically normalized.

Returns:

Line 2 of the address

getCity

public java.lang.String getCity()

The city name of the customer. This is automatically normalized.

Returns:

the address city

getSubdivision

public java.lang.String getSubdivision()

The subdivision of the entered country. For instance in the United States, this would be a 'state'.

Returns:

the address subdivision

getPostalCode

public java.lang.String getPostalCode()

The postal code, also known as the ZIP code of the address.

Returns:

the postal code

getCountryCode

public java.lang.String getCountryCode()

The country of the customer. Should be of the ISO code form.

Returns:

the country code