AddressDetails (a Java API for Kml 2.2.1 API)

java.lang.Object
- de.micromata.opengis.kml.v_2_2_0.xal.AddressDetails

All Implemented Interfaces:

Cloneable
```
public class AddressDetails
extends Object
implements Cloneable
```
A structured address, formatted as xAL, or eXtensible Address Language, an international standard for address formatting. is used by KML for geocoding in Google Maps only. For details, see the Google Maps API documentation. Currently, Google Earth does not use this element; use
instead. Be sure to include the namespace for this element in any KML file that uses it: xmlns:xal="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"

A structured address, formatted as xAL, or eXtensible Address Language, an international standard for address formatting. is used by KML for geocoding in Google Maps only. For details, see the Google Maps API documentation. Currently, Google Earth does not use this element; use
instead. Be sure to include the namespace for this element in any KML file that uses it: xmlns:xal="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"

Nested Class Summary

Nested Classes
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`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`address` A string value representing an unstructured address written as a standard street, city, state address, and/or as a postal code.
`protected String`	`addressDetailsKey`
`protected AddressLines`	`addressLines`
`protected AdministrativeArea`	`administrativeArea`
`protected List<Object>`	`any`
`protected String`	`code`
`protected AddressDetails.Country`	`country`
`protected String`	`currentStatus`
`protected Locality`	`locality`
`protected AddressDetails.PostalServiceElements`	`postalServiceElements`
`protected Thoroughfare`	`thoroughfare`
`protected String`	`usage`
`protected String`	`validFromDate`
`protected 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 Summary

Constructors
Constructor and Description
`AddressDetails(AddressDetails.Address xalAddress, AddressLines addressLines, AddressDetails.Country country, AdministrativeArea administrativeArea, Locality locality, Thoroughfare thoroughfare)` Value constructor with only mandatory fields

Method Summary

Methods
Modifier and Type	Method and Description
`AddressDetails`	`addToAny(Object any)` add a value to the any property collection
`AddressDetails`	`clone()`
`AddressLines`	`createAndSetAddressLines(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(Object obj)`
`String`	`getAddress()`
`String`	`getAddressDetailsKey()`
`AddressLines`	`getAddressLines()`
`AdministrativeArea`	`getAdministrativeArea()`
`List<Object>`	`getAny()`
`String`	`getCode()`
`AddressDetails.Country`	`getCountry()`
`String`	`getCurrentStatus()`
`Locality`	`getLocality()`
`Map<QName,String>`	`getOtherAttributes()`
`AddressDetails.PostalServiceElements`	`getPostalServiceElements()`
`Thoroughfare`	`getThoroughfare()`
`String`	`getUsage()`
`String`	`getValidFromDate()`
`String`	`getValidToDate()`
`AddressDetails.Address`	`getXalAddress()`
`int`	`hashCode()`
`void`	`setAddress(String value)`
`void`	`setAddressDetailsKey(String value)`
`void`	`setAddressLines(AddressLines value)`
`void`	`setAdministrativeArea(AdministrativeArea value)`
`void`	`setAny(List<Object> any)`
`void`	`setCode(String value)`
`void`	`setCountry(AddressDetails.Country value)`
`void`	`setCurrentStatus(String value)`
`void`	`setLocality(Locality value)`
`void`	`setPostalServiceElements(AddressDetails.PostalServiceElements value)`
`void`	`setThoroughfare(Thoroughfare value)`
`void`	`setUsage(String value)`
`void`	`setValidFromDate(String value)`
`void`	`setValidToDate(String value)`
`void`	`setXalAddress(AddressDetails.Address value)`
`AddressDetails`	`withAddress(String address)` fluent setter
`AddressDetails`	`withAddressDetailsKey(String addressDetailsKey)` fluent setter
`AddressDetails`	`withAny(List<Object> any)` fluent setter
`AddressDetails`	`withCode(String code)` fluent setter
`AddressDetails`	`withCurrentStatus(String currentStatus)` fluent setter
`AddressDetails`	`withPostalServiceElements(AddressDetails.PostalServiceElements postalServiceElements)` fluent setter
`AddressDetails`	`withUsage(String usage)` fluent setter
`AddressDetails`	`withValidFromDate(String validFromDate)` fluent setter
`AddressDetails`	`withValidToDate(String validToDate)` fluent setter

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

- Field Detail
  - postalServiceElements
```
protected AddressDetails.PostalServiceElements postalServiceElements
```
  - xalAddress
```
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 a is provided, it takes precedence over the
    .) To find out which locales are supported for this tag in Google Earth, go to the Google Maps Help.
  - addressLines
```
protected AddressLines addressLines
```
  - country
```
protected AddressDetails.Country country
```
  - administrativeArea
```
protected AdministrativeArea administrativeArea
```
  - locality
```
protected Locality locality
```
  - thoroughfare
```
protected Thoroughfare thoroughfare
```
  - any
```
protected List<Object> any
```
  - address
```
protected 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 a is provided, it takes precedence over the
    .) To find out which locales are supported for this tag in Google Earth, go to the Google Maps Help.
  - currentStatus
```
protected String currentStatus
```
  - validFromDate
```
protected String validFromDate
```
  - validToDate
```
protected String validToDate
```
  - usage
```
protected String usage
```
  - addressDetailsKey
```
protected String addressDetailsKey
```
  - code
```
protected String code
```
- Constructor Detail
  - AddressDetails
```
public AddressDetails(AddressDetails.Address xalAddress,
              AddressLines addressLines,
              AddressDetails.Country country,
              AdministrativeArea administrativeArea,
              Locality locality,
              Thoroughfare thoroughfare)
```
    Value constructor with only mandatory fields
    
    Parameters:
    xalAddress - required parameter
    addressLines - required parameter
    country - required parameter
    locality - required parameter
    administrativeArea - required parameter
    thoroughfare - required parameter
- Method Detail
  - getPostalServiceElements
```
public AddressDetails.PostalServiceElements getPostalServiceElements()
```
    Returns:
    possible object is AddressDetails.PostalServiceElements
    See Also:
    postalServiceElements
  - setPostalServiceElements
```
public void setPostalServiceElements(AddressDetails.PostalServiceElements value)
```
    Parameters:
    value - allowed object is AddressDetails.PostalServiceElements
    See Also:
    postalServiceElements
  - getXalAddress
```
public AddressDetails.Address getXalAddress()
```
    Returns:
    possible object is AddressDetails.Address
    See Also:
    xalAddress
  - setXalAddress
```
public void setXalAddress(AddressDetails.Address value)
```
    Parameters:
    value - allowed object is AddressDetails.Address
    See Also:
    xalAddress
  - getAddressLines
```
public AddressLines getAddressLines()
```
    Returns:
    possible object is AddressLines
    See Also:
    addressLines
  - setAddressLines
```
public void setAddressLines(AddressLines value)
```
    Parameters:
    value - allowed object is AddressLines
    See Also:
    addressLines
  - getCountry
```
public AddressDetails.Country getCountry()
```
    Returns:
    possible object is AddressDetails.Country
    See Also:
    country
  - setCountry
```
public void setCountry(AddressDetails.Country value)
```
    Parameters:
    value - allowed object is AddressDetails.Country
    See Also:
    country
  - getAdministrativeArea
```
public AdministrativeArea getAdministrativeArea()
```
    Returns:
    possible object is AdministrativeArea
    See Also:
    administrativeArea
  - setAdministrativeArea
```
public void setAdministrativeArea(AdministrativeArea value)
```
    Parameters:
    value - allowed object is AdministrativeArea
    See Also:
    administrativeArea
  - getLocality
```
public Locality getLocality()
```
    Returns:
    possible object is Locality
    See Also:
    locality
  - setLocality
```
public void setLocality(Locality value)
```
    Parameters:
    value - allowed object is Locality
    See Also:
    locality
  - getThoroughfare
```
public Thoroughfare getThoroughfare()
```
    Returns:
    possible object is Thoroughfare
    See Also:
    thoroughfare
  - setThoroughfare
```
public void setThoroughfare(Thoroughfare value)
```
    Parameters:
    value - allowed object is Thoroughfare
    See Also:
    thoroughfare
  - getAny
```
public List<Object> getAny()
```
    See Also:
    any
  - getAddress
```
public String getAddress()
```
    Returns:
    possible object is String
    See Also:
    address
  - setAddress
```
public void setAddress(String value)
```
    Parameters:
    value - allowed object is String
    See Also:
    address
  - getCurrentStatus
```
public String getCurrentStatus()
```
    Returns:
    possible object is String
    See Also:
    currentStatus
  - setCurrentStatus
```
public void setCurrentStatus(String value)
```
    Parameters:
    value - allowed object is String
    See Also:
    currentStatus
  - getValidFromDate
```
public String getValidFromDate()
```
    Returns:
    possible object is String
    See Also:
    validFromDate
  - setValidFromDate
```
public void setValidFromDate(String value)
```
    Parameters:
    value - allowed object is String
    See Also:
    validFromDate
  - getValidToDate
```
public String getValidToDate()
```
    Returns:
    possible object is String
    See Also:
    validToDate
  - setValidToDate
```
public void setValidToDate(String value)
```
    Parameters:
    value - allowed object is String
    See Also:
    validToDate
  - getUsage
```
public String getUsage()
```
    Returns:
    possible object is String
    See Also:
    usage
  - setUsage
```
public void setUsage(String value)
```
    Parameters:
    value - allowed object is String
    See Also:
    usage
  - getAddressDetailsKey
```
public String getAddressDetailsKey()
```
    Returns:
    possible object is String
    See Also:
    addressDetailsKey
  - setAddressDetailsKey
```
public void setAddressDetailsKey(String value)
```
    Parameters:
    value - allowed object is String
    See Also:
    addressDetailsKey
  - getCode
```
public String getCode()
```
    Returns:
    possible object is String
    See Also:
    code
  - setCode
```
public void setCode(String value)
```
    Parameters:
    value - allowed object is String
    See Also:
    code
  - getOtherAttributes
```
public Map<QName,String> getOtherAttributes()
```
    Returns:
    always non-null
    See Also:
    otherAttributes
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - createAndSetPostalServiceElements
```
public AddressDetails.PostalServiceElements createAndSetPostalServiceElements()
```
    Creates a new instance of AddressDetails.PostalServiceElements and set it to postalServiceElements. This method is a short version for: PostalServiceElements postalServiceElements = new PostalServiceElements(); this.setPostalServiceElements(postalServiceElements);
  - createAndSetXalAddress
```
public AddressDetails.Address createAndSetXalAddress()
```
    Creates a new instance of AddressDetails.Address and set it to xalAddress. This method is a short version for: Address address = new Address(); this.setXalAddress(address);
  - createAndSetAddressLines
```
public AddressLines createAndSetAddressLines(List<AddressLine> addressLine)
```
    Creates a new instance of AddressLines and set it to addressLines. This method is a short version for: AddressLines addressLines = new AddressLines(); this.setAddressLines(addressLines);
    
    Parameters:
    addressLine - required parameter
  - createAndSetCountry
```
public AddressDetails.Country createAndSetCountry(AdministrativeArea administrativeArea,
                                         Locality locality,
                                         Thoroughfare thoroughfare)
```
    Creates a new instance of AddressDetails.Country and set it to country. This method is a short version for: Country country = new Country(); this.setCountry(country);
    
    Parameters:
    locality - required parameter
    administrativeArea - required parameter
    thoroughfare - required parameter
  - createAndSetAdministrativeArea
```
public AdministrativeArea createAndSetAdministrativeArea(Locality locality,
                                                PostOffice postOffice,
                                                PostalCode postalCode)
```
    Creates a new instance of AdministrativeArea and set it to administrativeArea. This method is a short version for: AdministrativeArea administrativeArea = new AdministrativeArea(); this.setAdministrativeArea(administrativeArea);
    
    Parameters:
    postalCode - required parameter
    locality - required parameter
    postOffice - required parameter
  - createAndSetLocality
```
public Locality createAndSetLocality(PostBox postBox,
                            LargeMailUser largeMailUser,
                            PostOffice postOffice,
                            PostalRoute postalRoute)
```
    Creates a new instance of Locality and set it to locality. This method is a short version for: Locality locality = new Locality(); this.setLocality(locality);
    
    Parameters:
    postBox - required parameter
    postOffice - required parameter
    postalRoute - required parameter
    largeMailUser - required parameter
  - createAndSetThoroughfare
```
public Thoroughfare createAndSetThoroughfare(DependentLocality dependentLocality,
                                    Premise premise,
                                    Firm firm,
                                    PostalCode postalCode)
```
    Creates a new instance of Thoroughfare and set it to thoroughfare. This method is a short version for: Thoroughfare thoroughfare = new Thoroughfare(); this.setThoroughfare(thoroughfare);
    
    Parameters:
    postalCode - required parameter
    premise - required parameter
    firm - required parameter
    dependentLocality - required parameter
  - setAny
```
public void setAny(List<Object> any)
```
    Parameters:
    any -
    See Also:
    any
  - addToAny
```
public AddressDetails addToAny(Object any)
```
    add a value to the any property collection
    
    Parameters:
    any - Objects of the following type are allowed in the list: Object
    
    Returns:
    true (as general contract of Collection.add).
  - withPostalServiceElements
```
public AddressDetails withPostalServiceElements(AddressDetails.PostalServiceElements postalServiceElements)
```
    fluent setter
    
    Parameters:
    postalServiceElements - required parameter
    See Also:
    setPostalServiceElements(PostalServiceElements)
  - withAny
```
public AddressDetails withAny(List<Object> any)
```
    fluent setter
    Parameters:
    any - required parameter
    See Also:
    #setAny(List

Class AddressDetails

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

postalServiceElements

xalAddress

addressLines

country

administrativeArea

locality

thoroughfare

any

address

currentStatus

validFromDate

validToDate

usage

addressDetailsKey

code

Constructor Detail

AddressDetails

Method Detail

getPostalServiceElements

setPostalServiceElements

getXalAddress

setXalAddress

getAddressLines

setAddressLines

getCountry

setCountry

getAdministrativeArea

setAdministrativeArea

getLocality

setLocality

getThoroughfare

setThoroughfare

getAny

getAddress

setAddress

getCurrentStatus

setCurrentStatus

getValidFromDate

setValidFromDate

getValidToDate

setValidToDate

getUsage

setUsage

getAddressDetailsKey

setAddressDetailsKey

getCode

setCode

getOtherAttributes

hashCode

equals

createAndSetPostalServiceElements

createAndSetXalAddress

createAndSetAddressLines

createAndSetCountry

createAndSetAdministrativeArea

createAndSetLocality

createAndSetThoroughfare

setAny

addToAny

withPostalServiceElements

withAny

withAddress

withCurrentStatus

withValidFromDate

withValidToDate

withUsage

withAddressDetailsKey

withCode

clone