com.blockscore.models

Class Address

java.lang.Object

com.blockscore.models.Address

public class Address
extends Object

The address model.

Constructor Summary

Constructors

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

Method Summary

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

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

Parameters:

street1 - Street (Line 1)

Returns:

this

setStreet2

@Nullable
public Address setStreet2(@NotNull
                                    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(@NotNull
                                String city)

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

Parameters:

city - City

Returns:

this

setSubdivision

@NotNull
public Address setSubdivision(@NotNull
                                       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(@NotNull
                                      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(@NotNull
                                       String countryCode)

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

Parameters:

countryCode - the country code

Returns:

this

getStreet1

@NotNull
public String getStreet1()

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

Returns:

Line 1 of the address

getStreet2

@Nullable
public String getStreet2()

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

Returns:

Line 2 of the address

getCity

@NotNull
public String getCity()

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

Returns:

the address city

getSubdivision

@NotNull
public String getSubdivision()

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

Returns:

the address subdivision

getPostalCode

@NotNull
public String getPostalCode()

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

Returns:

the postal code

getCountryCode

@NotNull
public String getCountryCode()

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

Returns:

the country code