Address (Broadleaf Order Common 1.4.0-GA API)

java.lang.Object
- com.broadleafcommerce.order.common.domain.Address

All Implemented Interfaces:

Serializable
```
public class Address
extends Object
implements Serializable
```
The street address for a physical location.

Author:

Chad Harchar (charchar)

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Address()

Constructors
Constructor and Description
`Address()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAdditionalAttribute(String name, Object value)` Takes in any additional attributes passed in the request not matching any defined properties.
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`Map<String,Object>`	`getAdditionalAttributes()` Return any additional attributes passed in the request not matching any defined properties.
`String`	`getAddressLine1()` Primary address information, typically street name and building number.
`String`	`getAddressLine2()` Secondary address information, like apartment, suite, or unit number.
`String`	`getAddressLine3()` Tertiary address information, typically for international addresses.
`String`	`getCity()` The city, town or village of this address.
`String`	`getCompanyName()` The name of the company at this address.
`String`	`getCompletedName()` Returns the completed name : Either the `fullName` if present or the concatenation of the `firstName` and `lastName`.
`String`	`getCountry()` The country for this address.
`String`	`getCounty()` The county of this address.
`String`	`getEmailAddress()` The email address of the individual at this physical address.
`String`	`getFirstName()` The first name of the individual at this address.
`String`	`getFullName()` The combined names of the individual at this address.
`String`	`getLastName()` The last name of the individual at this address.
`Phone`	`getPhoneFax()` The `fax number` for this address.
`Phone`	`getPhonePrimary()` The primary `phone number` for this address.
`Phone`	`getPhoneSecondary()` The secondary `phone number` for this address.
`String`	`getPostalCode()` Postal code or ZIP code for this address.
`String`	`getStateProvinceRegion()` The state, province or region of this address.
`int`	`hashCode()`
`boolean`	`isActive()` Whether this address is an active address of the owner.
`boolean`	`isDefault()` Whether this address is the default address of the owner.
`void`	`setActive(boolean isActive)` Whether this address is an active address of the owner.
`void`	`setAdditionalAttributes(Map<String,Object> additionalAttributes)` Map holding any additional attributes passed in the request not matching any defined properties.
`void`	`setAddressLine1(String addressLine1)` Primary address information, typically street name and building number.
`void`	`setAddressLine2(String addressLine2)` Secondary address information, like apartment, suite, or unit number.
`void`	`setAddressLine3(String addressLine3)` Tertiary address information, typically for international addresses.
`void`	`setCity(String city)` The city, town or village of this address.
`void`	`setCompanyName(String companyName)` The name of the company at this address.
`void`	`setCountry(String country)` The country for this address.
`void`	`setCounty(String county)` The county of this address.
`void`	`setDefault(boolean isDefault)` Whether this address is the default address of the owner.
`void`	`setEmailAddress(String emailAddress)` The email address of the individual at this physical address.
`void`	`setFirstName(String firstName)` The first name of the individual at this address.
`void`	`setFullName(String fullName)` The combined names of the individual at this address.
`void`	`setLastName(String lastName)` The last name of the individual at this address.
`void`	`setPhoneFax(Phone phoneFax)` The `fax number` for this address.
`void`	`setPhonePrimary(Phone phonePrimary)` The primary `phone number` for this address.
`void`	`setPhoneSecondary(Phone phoneSecondary)` The secondary `phone number` for this address.
`void`	`setPostalCode(String postalCode)` Postal code or ZIP code for this address.
`void`	`setStateProvinceRegion(String stateProvinceRegion)` The state, province or region of this address.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Address
```
public Address()
```
- Method Detail
  - addAdditionalAttribute
```
public void addAdditionalAttribute(String name,
                                   Object value)
```
    Takes in any additional attributes passed in the request not matching any defined properties.
    
    Parameters:
    
    name - Name of the additional attribute
    
    value - Value of the additional attribute
  - getAdditionalAttributes
```
public Map<String,Object> getAdditionalAttributes()
```
    Return any additional attributes passed in the request not matching any defined properties.
    
    Returns:
    
    any additional attributes passed in the request not matching any defined properties.
  - getCompletedName
```
public String getCompletedName()
```
    Returns the completed name : Either the fullName if present or the concatenation of the firstName and lastName.
    
    Returns:
    
    the completed name : Either the fullName if present or the concatenation of the firstName and lastName.
  - getFirstName
```
public String getFirstName()
```
    The first name of the individual at this address.
    
    Returns:
    
    The first name of the individual at this address.
  - getLastName
```
public String getLastName()
```
    The last name of the individual at this address.
    
    Returns:
    
    The last name of the individual at this address.
  - getFullName
```
public String getFullName()
```
    The combined names of the individual at this address. It is considered better UX to use a full name field in place of separate first and last name fields.
    
    Returns:
    
    The combined names of the individual at this address
  - getEmailAddress
```
public String getEmailAddress()
```
    The email address of the individual at this physical address.
    
    Returns:
    
    The email address of the individual at this physical address.
  - getCompanyName
```
public String getCompanyName()
```
    The name of the company at this address.
    
    Returns:
    
    The name of the company at this address.
  - getAddressLine1
```
public String getAddressLine1()
```
    Primary address information, typically street name and building number.
    
    Returns:
    
    Primary address information, typically street name and building number.
  - getAddressLine2
```
public String getAddressLine2()
```
    Secondary address information, like apartment, suite, or unit number.
    
    Returns:
    
    Secondary address information, like apartment number or suite number.
  - getAddressLine3
```
public String getAddressLine3()
```
    Tertiary address information, typically for international addresses.
    
    Returns:
    
    Tertiary address information, typically for international addresses.
  - getCity
```
public String getCity()
```
    The city, town or village of this address.
    
    Returns:
    
    The city, town or village of this address.
  - getStateProvinceRegion
```
public String getStateProvinceRegion()
```
    The state, province or region of this address.
    
    Returns:
    
    The state, province or region of this address.
  - getCounty
```
public String getCounty()
```
    The county of this address.
    
    Returns:
    
    The county of this address.
  - getCountry
```
public String getCountry()
```
    The country for this address.
    
    Returns:
    
    The country for this address.
  - getPostalCode
```
public String getPostalCode()
```
    Postal code or ZIP code for this address.
    
    Returns:
    
    Postal code or ZIP code for this address.
  - getPhonePrimary
```
public Phone getPhonePrimary()
```
    The primary phone number for this address.
    
    Returns:
    
    The primary phone number for this address.
  - getPhoneSecondary
```
public Phone getPhoneSecondary()
```
    The secondary phone number for this address.
    
    Returns:
    
    The secondary phone number for this address.
  - getPhoneFax
```
public Phone getPhoneFax()
```
    The fax number for this address.
    
    Returns:
    
    The fax number for this address.
  - isDefault
```
public boolean isDefault()
```
    Whether this address is the default address of the owner.
    
    Returns:
    
    Whether this address is the default address of the owner.
  - isActive
```
public boolean isActive()
```
    Whether this address is an active address of the owner.
    
    Returns:
    
    Whether this address is an active address of the owner.
  - setFirstName
```
public void setFirstName(String firstName)
```
    The first name of the individual at this address.
    
    Parameters:
    
    firstName - The first name of the individual at this address.
  - setLastName
```
public void setLastName(String lastName)
```
    The last name of the individual at this address.
    
    Parameters:
    
    lastName - The last name of the individual at this address.
  - setFullName
```
public void setFullName(String fullName)
```
    The combined names of the individual at this address. It is considered better UX to use a full name field in place of separate first and last name fields.
    
    Parameters:
    
    fullName - The combined names of the individual at this address
  - setEmailAddress
```
public void setEmailAddress(String emailAddress)
```
    The email address of the individual at this physical address.
    
    Parameters:
    
    emailAddress - The email address of the individual at this physical address.
  - setCompanyName
```
public void setCompanyName(String companyName)
```
    The name of the company at this address.
    
    Parameters:
    
    companyName - The name of the company at this address.
  - setAddressLine1
```
public void setAddressLine1(String addressLine1)
```
    Primary address information, typically street name and building number.
    
    Parameters:
    
    addressLine1 - Primary address information, typically street name and building number.
  - setAddressLine2
```
public void setAddressLine2(String addressLine2)
```
    Secondary address information, like apartment, suite, or unit number.
    
    Parameters:
    
    addressLine2 - Secondary address information, like apartment number or suite number.
  - setAddressLine3
```
public void setAddressLine3(String addressLine3)
```
    Tertiary address information, typically for international addresses.
    
    Parameters:
    
    addressLine3 - Tertiary address information, typically for international addresses.
  - setCity
```
public void setCity(String city)
```
    The city, town or village of this address.
    
    Parameters:
    
    city - The city, town or village of this address.
  - setStateProvinceRegion
```
public void setStateProvinceRegion(String stateProvinceRegion)
```
    The state, province or region of this address.
    
    Parameters:
    
    stateProvinceRegion - The state, province or region of this address.
  - setCounty
```
public void setCounty(String county)
```
    The county of this address.
    
    Parameters:
    
    county - The county of this address.
  - setCountry
```
public void setCountry(String country)
```
    The country for this address.
    
    Parameters:
    
    country - The country for this address.
  - setPostalCode
```
public void setPostalCode(String postalCode)
```
    Postal code or ZIP code for this address.
    
    Parameters:
    
    postalCode - Postal code or ZIP code for this address.
  - setPhonePrimary
```
public void setPhonePrimary(Phone phonePrimary)
```
    The primary phone number for this address.
    
    Parameters:
    
    phonePrimary - The primary phone number for this address.
  - setPhoneSecondary
```
public void setPhoneSecondary(Phone phoneSecondary)
```
    The secondary phone number for this address.
    
    Parameters:
    
    phoneSecondary - The secondary phone number for this address.
  - setPhoneFax
```
public void setPhoneFax(Phone phoneFax)
```
    The fax number for this address.
    
    Parameters:
    
    phoneFax - The fax number for this address.
  - setDefault
```
public void setDefault(boolean isDefault)
```
    Whether this address is the default address of the owner.
    
    Parameters:
    
    isDefault - Whether this address is the default address of the owner.
  - setActive
```
public void setActive(boolean isActive)
```
    Whether this address is an active address of the owner.
    
    Parameters:
    
    isActive - Whether this address is an active address of the owner.
  - setAdditionalAttributes
```
public void setAdditionalAttributes(Map<String,Object> additionalAttributes)
```
    Map holding any additional attributes passed in the request not matching any defined properties.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Address

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Address

Method Detail

addAdditionalAttribute

getAdditionalAttributes

getCompletedName

getFirstName

getLastName

getFullName

getEmailAddress

getCompanyName

getAddressLine1

getAddressLine2

getAddressLine3

getCity

getStateProvinceRegion

getCounty

getCountry

getPostalCode

getPhonePrimary

getPhoneSecondary

getPhoneFax

isDefault

isActive

setFirstName

setLastName

setFullName

setEmailAddress

setCompanyName

setAddressLine1

setAddressLine2

setAddressLine3

setCity

setStateProvinceRegion

setCounty

setCountry

setPostalCode

setPhonePrimary

setPhoneSecondary

setPhoneFax

setDefault

setActive

setAdditionalAttributes

equals

canEqual

hashCode

toString