AdministrativeArea (a Java API for Kml 2.2.1 API)

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

All Implemented Interfaces:: Cloneable

public class AdministrativeArea
extends Object
implements Cloneable

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AdministrativeArea.AdministrativeAreaName

static class AdministrativeArea.SubAdministrativeArea

Nested Classes
Modifier and Type	Class and Description
`static class`	`AdministrativeArea.AdministrativeAreaName`
`static class`	`AdministrativeArea.SubAdministrativeArea`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<AddressLine>`	`addressLine`
`protected List<AdministrativeArea.AdministrativeAreaName>`	`administrativeAreaName`
`protected List<Object>`	`any`
`protected String`	`indicator`
`protected Locality`	`locality`
`protected PostalCode`	`postalCode`
`protected PostOffice`	`postOffice`
`protected AdministrativeArea.SubAdministrativeArea`	`subAdministrativeArea`
`protected String`	`underscore`
`protected String`	`usage`

Constructor Summary

Constructors
Constructor and Description
`AdministrativeArea(Locality locality, PostOffice postOffice, PostalCode postalCode)` Value constructor with only mandatory fields

Method Summary

Methods
Modifier and Type	Method and Description
`AdministrativeArea`	`addToAddressLine(AddressLine addressLine)` add a value to the addressLine property collection
`AdministrativeArea`	`addToAdministrativeAreaName(AdministrativeArea.AdministrativeAreaName administrativeAreaName)` add a value to the administrativeAreaName property collection
`AdministrativeArea`	`addToAny(Object any)` add a value to the any property collection
`AdministrativeArea`	`clone()`
`AddressLine`	`createAndAddAddressLine()` Creates a new instance of `AddressLine` and adds it to addressLine.
`AdministrativeArea.AdministrativeAreaName`	`createAndAddAdministrativeAreaName()` Creates a new instance of `AdministrativeArea.AdministrativeAreaName` and adds it to administrativeAreaName.
`Locality`	`createAndSetLocality(PostBox postBox, LargeMailUser largeMailUser, PostOffice postOffice, PostalRoute postalRoute)` Creates a new instance of `Locality` and set it to locality.
`PostalCode`	`createAndSetPostalCode()` Creates a new instance of `PostalCode` and set it to postalCode.
`PostOffice`	`createAndSetPostOffice()` Creates a new instance of `PostOffice` and set it to postOffice.
`AdministrativeArea.SubAdministrativeArea`	`createAndSetSubAdministrativeArea(Locality locality, PostOffice postOffice, PostalCode postalCode)` Creates a new instance of `AdministrativeArea.SubAdministrativeArea` and set it to subAdministrativeArea.
`boolean`	`equals(Object obj)`
`List<AddressLine>`	`getAddressLine()`
`List<AdministrativeArea.AdministrativeAreaName>`	`getAdministrativeAreaName()`
`List<Object>`	`getAny()`
`String`	`getIndicator()`
`Locality`	`getLocality()`
`Map<QName,String>`	`getOtherAttributes()`
`PostalCode`	`getPostalCode()`
`PostOffice`	`getPostOffice()`
`AdministrativeArea.SubAdministrativeArea`	`getSubAdministrativeArea()`
`String`	`getUnderscore()`
`String`	`getUsage()`
`int`	`hashCode()`
`void`	`setAddressLine(List<AddressLine> addressLine)` Sets the value of the addressLine property Objects of the following type(s) are allowed in the list List.
`void`	`setAdministrativeAreaName(List<AdministrativeArea.AdministrativeAreaName> administrativeAreaName)` Sets the value of the administrativeAreaName property Objects of the following type(s) are allowed in the list List.
`void`	`setAny(List<Object> any)` Sets the value of the any property Objects of the following type(s) are allowed in the list List
`void`	`setIndicator(String value)`
`void`	`setLocality(Locality value)`
`void`	`setPostalCode(PostalCode value)`
`void`	`setPostOffice(PostOffice value)`
`void`	`setSubAdministrativeArea(AdministrativeArea.SubAdministrativeArea value)`
`void`	`setUnderscore(String value)`
`void`	`setUsage(String value)`
`AdministrativeArea`	`withAddressLine(List<AddressLine> addressLine)` fluent setter
`AdministrativeArea`	`withAdministrativeAreaName(List<AdministrativeArea.AdministrativeAreaName> administrativeAreaName)` fluent setter
`AdministrativeArea`	`withAny(List<Object> any)` fluent setter
`AdministrativeArea`	`withIndicator(String indicator)` fluent setter
`AdministrativeArea`	`withSubAdministrativeArea(AdministrativeArea.SubAdministrativeArea subAdministrativeArea)` fluent setter
`AdministrativeArea`	`withUnderscore(String underscore)` fluent setter
`AdministrativeArea`	`withUsage(String usage)` fluent setter

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

- Field Detail
  - addressLine
```
protected List<AddressLine> addressLine
```
  - administrativeAreaName
```
protected List<AdministrativeArea.AdministrativeAreaName> administrativeAreaName
```
  - subAdministrativeArea
```
protected AdministrativeArea.SubAdministrativeArea subAdministrativeArea
```
  - locality
```
protected Locality locality
```
  - postOffice
```
protected PostOffice postOffice
```
  - postalCode
```
protected PostalCode postalCode
```
  - any
```
protected List<Object> any
```
  - underscore
```
protected String underscore
```
  - usage
```
protected String usage
```
  - indicator
```
protected String indicator
```
- Constructor Detail
  - AdministrativeArea
```
public AdministrativeArea(Locality locality,
                  PostOffice postOffice,
                  PostalCode postalCode)
```
    Value constructor with only mandatory fields
    
    Parameters:
    postalCode - required parameter
    locality - required parameter
    postOffice - required parameter
- Method Detail
  - getAddressLine
```
public List<AddressLine> getAddressLine()
```
  - getAdministrativeAreaName
```
public List<AdministrativeArea.AdministrativeAreaName> getAdministrativeAreaName()
```
  - getSubAdministrativeArea
```
public AdministrativeArea.SubAdministrativeArea getSubAdministrativeArea()
```
    Returns:
    possible object is AdministrativeArea.SubAdministrativeArea
  - setSubAdministrativeArea
```
public void setSubAdministrativeArea(AdministrativeArea.SubAdministrativeArea value)
```
    Parameters:
    value - allowed object is AdministrativeArea.SubAdministrativeArea
  - getLocality
```
public Locality getLocality()
```
    Returns:
    possible object is Locality
  - setLocality
```
public void setLocality(Locality value)
```
    Parameters:
    value - allowed object is Locality
  - getPostOffice
```
public PostOffice getPostOffice()
```
    Returns:
    possible object is PostOffice
  - setPostOffice
```
public void setPostOffice(PostOffice value)
```
    Parameters:
    value - allowed object is PostOffice
  - getPostalCode
```
public PostalCode getPostalCode()
```
    Returns:
    possible object is PostalCode
  - setPostalCode
```
public void setPostalCode(PostalCode value)
```
    Parameters:
    value - allowed object is PostalCode
  - getAny
```
public List<Object> getAny()
```
  - getUnderscore
```
public String getUnderscore()
```
    Returns:
    possible object is String
  - setUnderscore
```
public void setUnderscore(String value)
```
    Parameters:
    value - allowed object is String
  - getUsage
```
public String getUsage()
```
    Returns:
    possible object is String
  - setUsage
```
public void setUsage(String value)
```
    Parameters:
    value - allowed object is String
  - getIndicator
```
public String getIndicator()
```
    Returns:
    possible object is String
  - setIndicator
```
public void setIndicator(String value)
```
    Parameters:
    value - allowed object is String
  - getOtherAttributes
```
public Map<QName,String> getOtherAttributes()
```
    Returns:
    always non-null
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - createAndAddAddressLine
```
public AddressLine createAndAddAddressLine()
```
    Creates a new instance of AddressLine and adds it to addressLine. This method is a short version for: AddressLine addressLine = new AddressLine(); this.getAddressLine().add(addressLine);
  - createAndAddAdministrativeAreaName
```
public AdministrativeArea.AdministrativeAreaName createAndAddAdministrativeAreaName()
```
    Creates a new instance of AdministrativeArea.AdministrativeAreaName and adds it to administrativeAreaName. This method is a short version for: AdministrativeAreaName administrativeAreaName = new AdministrativeAreaName(); this.getAdministrativeAreaName().add(administrativeAreaName);
  - createAndSetSubAdministrativeArea
```
public AdministrativeArea.SubAdministrativeArea createAndSetSubAdministrativeArea(Locality locality,
                                                                         PostOffice postOffice,
                                                                         PostalCode postalCode)
```
    Creates a new instance of AdministrativeArea.SubAdministrativeArea and set it to subAdministrativeArea. This method is a short version for: SubAdministrativeArea subAdministrativeArea = new SubAdministrativeArea(); this.setSubAdministrativeArea(subAdministrativeArea);
    
    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
  - createAndSetPostOffice
```
public PostOffice createAndSetPostOffice()
```
    Creates a new instance of PostOffice and set it to postOffice. This method is a short version for: PostOffice postOffice = new PostOffice(); this.setPostOffice(postOffice);
  - createAndSetPostalCode
```
public PostalCode createAndSetPostalCode()
```
    Creates a new instance of PostalCode and set it to postalCode. This method is a short version for: PostalCode postalCode = new PostalCode(); this.setPostalCode(postalCode);
  - setAddressLine
```
public void setAddressLine(List<AddressLine> addressLine)
```
    Sets the value of the addressLine property Objects of the following type(s) are allowed in the list List.
    Note:
    This method does not make use of the fluent pattern.If you would like to make it fluent, use withAddressLine(java.util.List<de.micromata.opengis.kml.v_2_2_0.xal.AddressLine>) instead.
    
    Parameters:
    addressLine -
  - addToAddressLine
```
public AdministrativeArea addToAddressLine(AddressLine addressLine)
```
    add a value to the addressLine property collection
    
    Parameters:
    addressLine - Objects of the following type are allowed in the list: AddressLine
    
    Returns:
    true (as general contract of Collection.add).
  - setAdministrativeAreaName
```
public void setAdministrativeAreaName(List<AdministrativeArea.AdministrativeAreaName> administrativeAreaName)
```
    Sets the value of the administrativeAreaName property Objects of the following type(s) are allowed in the list List.
    Note:
    This method does not make use of the fluent pattern.If you would like to make it fluent, use withAdministrativeAreaName(java.util.List<de.micromata.opengis.kml.v_2_2_0.xal.AdministrativeArea.AdministrativeAreaName>) instead.
    
    Parameters:
    administrativeAreaName -
  - addToAdministrativeAreaName
```
public AdministrativeArea addToAdministrativeAreaName(AdministrativeArea.AdministrativeAreaName administrativeAreaName)
```
    add a value to the administrativeAreaName property collection
    
    Parameters:
    administrativeAreaName - Objects of the following type are allowed in the list: AdministrativeArea.AdministrativeAreaName
    
    Returns:
    true (as general contract of Collection.add).
  - setAny
```
public void setAny(List<Object> any)
```
    Sets the value of the any property Objects of the following type(s) are allowed in the list List
    .
    Note:
    This method does not make use of the fluent pattern.If you would like to make it fluent, use withAny(java.util.List<java.lang.Object>) instead.
    Parameters:
    any -
    
    addToAny
    
    public AdministrativeArea 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).
    
    withAddressLine
    
    public AdministrativeArea withAddressLine(List<AddressLine> addressLine)
    
    fluent setter
    
    Parameters:
    addressLine - required parameter
    See Also:
    #setAddressLine(List)
    
    withAdministrativeAreaName
    
    public AdministrativeArea withAdministrativeAreaName(List<AdministrativeArea.AdministrativeAreaName> administrativeAreaName)
    
    fluent setter
    
    Parameters:
    administrativeAreaName - required parameter
    See Also:
    #setAdministrativeAreaName(List)
    
    withSubAdministrativeArea
    
    public AdministrativeArea withSubAdministrativeArea(AdministrativeArea.SubAdministrativeArea subAdministrativeArea)
    
    fluent setter
    
    Parameters:
    subAdministrativeArea - required parameter
    See Also:
    setSubAdministrativeArea(SubAdministrativeArea)
    
    withAny
    
    public AdministrativeArea withAny(List<Object> any)
    
    fluent setter
    
    Parameters:
    any - required parameter
    See Also:
    #setAny(List

Class AdministrativeArea

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

addressLine

administrativeAreaName

subAdministrativeArea

locality

postOffice

postalCode

any

underscore

usage

indicator

Constructor Detail

AdministrativeArea

Method Detail

getAddressLine

getAdministrativeAreaName

getSubAdministrativeArea

setSubAdministrativeArea

getLocality

setLocality

getPostOffice

setPostOffice

getPostalCode

setPostalCode

getAny

getUnderscore

setUnderscore

getUsage

setUsage

getIndicator

setIndicator

getOtherAttributes

hashCode

equals

createAndAddAddressLine

createAndAddAdministrativeAreaName

createAndSetSubAdministrativeArea

createAndSetLocality

createAndSetPostOffice

createAndSetPostalCode

setAddressLine

addToAddressLine

setAdministrativeAreaName

addToAdministrativeAreaName

setAny

addToAny

withAddressLine

withAdministrativeAreaName

withSubAdministrativeArea

withAny

withUnderscore

withUsage

withIndicator

clone