public class AddressDetails
extends java.lang.Object
implements java.lang.Cloneable
A structured address, formatted as xAL, or eXtensible Address Language, an international
standard for address formatting.
A structured address, formatted as xAL, or eXtensible Address Language, an international
standard for address formatting.
| Modifier and Type | Class and Description |
|---|---|
static class |
AddressDetails.Address
A string value representing an unstructured address written as a standard street,
city, state address, and/or as a postal code.
|
static class |
AddressDetails.Country |
static class |
AddressDetails.PostalServiceElements |
| Modifier and Type | Field and Description |
|---|---|
protected java.lang.String |
address
A string value representing an unstructured address written as a standard street,
city, state address, and/or as a postal code.
|
protected java.lang.String |
addressDetailsKey |
protected AddressLines |
addressLines |
protected AdministrativeArea |
administrativeArea |
protected java.util.List<java.lang.Object> |
any |
protected java.lang.String |
code |
protected AddressDetails.Country |
country |
protected java.lang.String |
currentStatus |
protected Locality |
locality |
protected AddressDetails.PostalServiceElements |
postalServiceElements |
protected Thoroughfare |
thoroughfare |
protected java.lang.String |
usage |
protected java.lang.String |
validFromDate |
protected java.lang.String |
validToDate |
protected AddressDetails.Address |
xalAddress
A string value representing an unstructured address written as a standard street,
city, state address, and/or as a postal code.
|
| Constructor and Description |
|---|
AddressDetails(AddressDetails.Address xalAddress,
AddressLines addressLines,
AddressDetails.Country country,
AdministrativeArea administrativeArea,
Locality locality,
Thoroughfare thoroughfare)
Value constructor with only mandatory fields
|
| Modifier and Type | Method and Description |
|---|---|
AddressDetails |
addToAny(java.lang.Object any)
add a value to the any property collection
|
AddressDetails |
clone() |
AddressLines |
createAndSetAddressLines(java.util.List<AddressLine> addressLine)
Creates a new instance of
AddressLines and set it to addressLines. |
AdministrativeArea |
createAndSetAdministrativeArea(Locality locality,
PostOffice postOffice,
PostalCode postalCode)
Creates a new instance of
AdministrativeArea and set it to administrativeArea. |
AddressDetails.Country |
createAndSetCountry(AdministrativeArea administrativeArea,
Locality locality,
Thoroughfare thoroughfare)
Creates a new instance of
AddressDetails.Country and set it to country. |
Locality |
createAndSetLocality(PostBox postBox,
LargeMailUser largeMailUser,
PostOffice postOffice,
PostalRoute postalRoute)
Creates a new instance of
Locality and set it to locality. |
AddressDetails.PostalServiceElements |
createAndSetPostalServiceElements()
Creates a new instance of
AddressDetails.PostalServiceElements and set it to postalServiceElements. |
Thoroughfare |
createAndSetThoroughfare(DependentLocality dependentLocality,
Premise premise,
Firm firm,
PostalCode postalCode)
Creates a new instance of
Thoroughfare and set it to thoroughfare. |
AddressDetails.Address |
createAndSetXalAddress()
Creates a new instance of
AddressDetails.Address and set it to xalAddress. |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAddress() |
java.lang.String |
getAddressDetailsKey() |
AddressLines |
getAddressLines() |
AdministrativeArea |
getAdministrativeArea() |
java.util.List<java.lang.Object> |
getAny() |
java.lang.String |
getCode() |
AddressDetails.Country |
getCountry() |
java.lang.String |
getCurrentStatus() |
Locality |
getLocality() |
java.util.Map<javax.xml.namespace.QName,java.lang.String> |
getOtherAttributes() |
AddressDetails.PostalServiceElements |
getPostalServiceElements() |
Thoroughfare |
getThoroughfare() |
java.lang.String |
getUsage() |
java.lang.String |
getValidFromDate() |
java.lang.String |
getValidToDate() |
AddressDetails.Address |
getXalAddress() |
int |
hashCode() |
void |
setAddress(java.lang.String value) |
void |
setAddressDetailsKey(java.lang.String value) |
void |
setAddressLines(AddressLines value) |
void |
setAdministrativeArea(AdministrativeArea value) |
void |
setAny(java.util.List<java.lang.Object> any) |
void |
setCode(java.lang.String value) |
void |
setCountry(AddressDetails.Country value) |
void |
setCurrentStatus(java.lang.String value) |
void |
setLocality(Locality value) |
void |
setPostalServiceElements(AddressDetails.PostalServiceElements value) |
void |
setThoroughfare(Thoroughfare value) |
void |
setUsage(java.lang.String value) |
void |
setValidFromDate(java.lang.String value) |
void |
setValidToDate(java.lang.String value) |
void |
setXalAddress(AddressDetails.Address value) |
AddressDetails |
withAddress(java.lang.String address)
fluent setter
|
AddressDetails |
withAddressDetailsKey(java.lang.String addressDetailsKey)
fluent setter
|
AddressDetails |
withAny(java.util.List<java.lang.Object> any)
fluent setter
|
AddressDetails |
withCode(java.lang.String code)
fluent setter
|
AddressDetails |
withCurrentStatus(java.lang.String currentStatus)
fluent setter
|
AddressDetails |
withPostalServiceElements(AddressDetails.PostalServiceElements postalServiceElements)
fluent setter
|
AddressDetails |
withUsage(java.lang.String usage)
fluent setter
|
AddressDetails |
withValidFromDate(java.lang.String validFromDate)
fluent setter
|
AddressDetails |
withValidToDate(java.lang.String validToDate)
fluent setter
|
protected AddressDetails.PostalServiceElements postalServiceElements
protected AddressDetails.Address xalAddress
A string value representing an unstructured address written as a standard street, city, state address, and/or as a postal code. You can use the
tag to specify the location of a point instead of using latitude and longitude coordinates. (However, if aprotected AddressLines addressLines
protected AddressDetails.Country country
protected AdministrativeArea administrativeArea
protected Locality locality
protected Thoroughfare thoroughfare
protected java.util.List<java.lang.Object> any
protected java.lang.String address
A string value representing an unstructured address written as a standard street, city, state address, and/or as a postal code. You can use the
tag to specify the location of a point instead of using latitude and longitude coordinates. (However, if aprotected java.lang.String currentStatus
protected java.lang.String validFromDate
protected java.lang.String validToDate
protected java.lang.String usage
protected java.lang.String addressDetailsKey
protected java.lang.String code
public AddressDetails(AddressDetails.Address xalAddress, AddressLines addressLines, AddressDetails.Country country, AdministrativeArea administrativeArea, Locality locality, Thoroughfare thoroughfare)
xalAddress - required parameteraddressLines - required parametercountry - required parameterlocality - required parameteradministrativeArea - required parameterthoroughfare - required parameterpublic AddressDetails.PostalServiceElements getPostalServiceElements()
AddressDetails.PostalServiceElementspostalServiceElementspublic void setPostalServiceElements(AddressDetails.PostalServiceElements value)
value - allowed object is
AddressDetails.PostalServiceElementspostalServiceElementspublic AddressDetails.Address getXalAddress()
AddressDetails.AddressxalAddresspublic void setXalAddress(AddressDetails.Address value)
value - allowed object is
AddressDetails.AddressxalAddresspublic AddressLines getAddressLines()
AddressLinesaddressLinespublic void setAddressLines(AddressLines value)
value - allowed object is
AddressLinesaddressLinespublic AddressDetails.Country getCountry()
AddressDetails.Countrycountrypublic void setCountry(AddressDetails.Country value)
value - allowed object is
AddressDetails.Countrycountrypublic AdministrativeArea getAdministrativeArea()
AdministrativeAreaadministrativeAreapublic void setAdministrativeArea(AdministrativeArea value)
value - allowed object is
AdministrativeAreaadministrativeAreapublic void setLocality(Locality value)
value - allowed object is
Localitylocalitypublic Thoroughfare getThoroughfare()
Thoroughfarethoroughfarepublic void setThoroughfare(Thoroughfare value)
value - allowed object is
Thoroughfarethoroughfarepublic java.util.List<java.lang.Object> getAny()
anypublic java.lang.String getAddress()
Stringaddresspublic void setAddress(java.lang.String value)
value - allowed object is
Stringaddresspublic java.lang.String getCurrentStatus()
StringcurrentStatuspublic void setCurrentStatus(java.lang.String value)
value - allowed object is
StringcurrentStatuspublic java.lang.String getValidFromDate()
StringvalidFromDatepublic void setValidFromDate(java.lang.String value)
value - allowed object is
StringvalidFromDatepublic java.lang.String getValidToDate()
StringvalidToDatepublic void setValidToDate(java.lang.String value)
value - allowed object is
StringvalidToDatepublic java.lang.String getUsage()
Stringusagepublic void setUsage(java.lang.String value)
value - allowed object is
Stringusagepublic java.lang.String getAddressDetailsKey()
StringaddressDetailsKeypublic void setAddressDetailsKey(java.lang.String value)
value - allowed object is
StringaddressDetailsKeypublic java.lang.String getCode()
Stringcodepublic void setCode(java.lang.String value)
value - allowed object is
Stringcodepublic java.util.Map<javax.xml.namespace.QName,java.lang.String> getOtherAttributes()
otherAttributespublic int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Objectpublic AddressDetails.PostalServiceElements createAndSetPostalServiceElements()
AddressDetails.PostalServiceElements and set it to postalServiceElements.
This method is a short version for:
PostalServiceElements postalServiceElements = new PostalServiceElements();
this.setPostalServiceElements(postalServiceElements); public AddressDetails.Address createAndSetXalAddress()
AddressDetails.Address and set it to xalAddress.
This method is a short version for:
Address address = new Address();
this.setXalAddress(address); public AddressLines createAndSetAddressLines(java.util.List<AddressLine> addressLine)
AddressLines and set it to addressLines.
This method is a short version for:
AddressLines addressLines = new AddressLines();
this.setAddressLines(addressLines); addressLine - required parameterpublic AddressDetails.Country createAndSetCountry(AdministrativeArea administrativeArea, Locality locality, Thoroughfare thoroughfare)
AddressDetails.Country and set it to country.
This method is a short version for:
Country country = new Country();
this.setCountry(country); locality - required parameteradministrativeArea - required parameterthoroughfare - required parameterpublic AdministrativeArea createAndSetAdministrativeArea(Locality locality, PostOffice postOffice, PostalCode postalCode)
AdministrativeArea and set it to administrativeArea.
This method is a short version for:
AdministrativeArea administrativeArea = new AdministrativeArea();
this.setAdministrativeArea(administrativeArea); postalCode - required parameterlocality - required parameterpostOffice - required parameterpublic Locality createAndSetLocality(PostBox postBox, LargeMailUser largeMailUser, PostOffice postOffice, PostalRoute postalRoute)
Locality and set it to locality.
This method is a short version for:
Locality locality = new Locality();
this.setLocality(locality); postBox - required parameterpostOffice - required parameterpostalRoute - required parameterlargeMailUser - required parameterpublic Thoroughfare createAndSetThoroughfare(DependentLocality dependentLocality, Premise premise, Firm firm, PostalCode postalCode)
Thoroughfare and set it to thoroughfare.
This method is a short version for:
Thoroughfare thoroughfare = new Thoroughfare();
this.setThoroughfare(thoroughfare); postalCode - required parameterpremise - required parameterfirm - required parameterdependentLocality - required parameterpublic void setAny(java.util.List<java.lang.Object> any)
any - anypublic AddressDetails addToAny(java.lang.Object any)
any - Objects of the following type are allowed in the list: Objectpublic AddressDetails withPostalServiceElements(AddressDetails.PostalServiceElements postalServiceElements)
postalServiceElements - required parametersetPostalServiceElements(PostalServiceElements)public AddressDetails withAny(java.util.List<java.lang.Object> any)
any - required parameter#setAny(Listpublic AddressDetails withAddress(java.lang.String address)
address - required parametersetAddress(String)public AddressDetails withCurrentStatus(java.lang.String currentStatus)
currentStatus - required parametersetCurrentStatus(String)public AddressDetails withValidFromDate(java.lang.String validFromDate)
validFromDate - required parametersetValidFromDate(String)public AddressDetails withValidToDate(java.lang.String validToDate)
validToDate - required parametersetValidToDate(String)public AddressDetails withUsage(java.lang.String usage)
usage - required parametersetUsage(String)public AddressDetails withAddressDetailsKey(java.lang.String addressDetailsKey)
addressDetailsKey - required parametersetAddressDetailsKey(String)public AddressDetails withCode(java.lang.String code)
code - required parametersetCode(String)public AddressDetails clone()
clone in class java.lang.ObjectCopyright © 2014 Micromata GmbH. All Rights Reserved.