DependentLocality (a Java API for Kml 2.2.1 API)

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

All Implemented Interfaces:: Cloneable

public class DependentLocality
extends Object
implements Cloneable

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DependentLocality.DependentLocalityName

static class DependentLocality.DependentLocalityNumber

Nested Classes
Modifier and Type	Class and Description
`static class`	`DependentLocality.DependentLocalityName`
`static class`	`DependentLocality.DependentLocalityNumber`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<AddressLine>`	`addressLine`
`protected List<Object>`	`any`
`protected String`	`connector`
`protected DependentLocality`	`dependentLocality`
`protected List<DependentLocality.DependentLocalityName>`	`dependentLocalityName`
`protected DependentLocality.DependentLocalityNumber`	`dependentLocalityNumber`
`protected String`	`indicator`
`protected LargeMailUser`	`largeMailUser`
`protected PostalCode`	`postalCode`
`protected PostalRoute`	`postalRoute`
`protected PostBox`	`postBox`
`protected PostOffice`	`postOffice`
`protected Premise`	`premise`
`protected Thoroughfare`	`thoroughfare`
`protected String`	`underscore`
`protected String`	`usage`

Constructor Summary

Constructors
Constructor and Description
`DependentLocality(PostBox postBox, LargeMailUser largeMailUser, PostOffice postOffice, PostalRoute postalRoute)` Value constructor with only mandatory fields

Method Summary

Methods
Modifier and Type	Method and Description
`DependentLocality`	`addToAddressLine(AddressLine addressLine)` add a value to the addressLine property collection
`DependentLocality`	`addToAny(Object any)` add a value to the any property collection
`DependentLocality`	`addToDependentLocalityName(DependentLocality.DependentLocalityName dependentLocalityName)` add a value to the dependentLocalityName property collection
`DependentLocality`	`clone()`
`AddressLine`	`createAndAddAddressLine()` Creates a new instance of `AddressLine` and adds it to addressLine.
`DependentLocality.DependentLocalityName`	`createAndAddDependentLocalityName()` Creates a new instance of `DependentLocality.DependentLocalityName` and adds it to dependentLocalityName.
`DependentLocality`	`createAndSetDependentLocality(PostBox postBox, LargeMailUser largeMailUser, PostOffice postOffice, PostalRoute postalRoute)` Creates a new instance of `DependentLocality` and set it to dependentLocality.
`DependentLocality.DependentLocalityNumber`	`createAndSetDependentLocalityNumber()` Creates a new instance of `DependentLocality.DependentLocalityNumber` and set it to dependentLocalityNumber.
`LargeMailUser`	`createAndSetLargeMailUser()` Creates a new instance of `LargeMailUser` and set it to largeMailUser.
`PostalCode`	`createAndSetPostalCode()` Creates a new instance of `PostalCode` and set it to postalCode.
`PostalRoute`	`createAndSetPostalRoute(List<PostalRoute.PostalRouteName> postalRouteName, PostalRoute.PostalRouteNumber postalRouteNumber)` Creates a new instance of `PostalRoute` and set it to postalRoute.
`PostBox`	`createAndSetPostBox(PostBox.PostBoxNumber postBoxNumber)` Creates a new instance of `PostBox` and set it to postBox.
`PostOffice`	`createAndSetPostOffice()` Creates a new instance of `PostOffice` and set it to postOffice.
`Premise`	`createAndSetPremise(Premise.PremiseLocation premiseLocation, List<PremiseNumber> premiseNumber, Premise.PremiseNumberRange premiseNumberRange)` Creates a new instance of `Premise` and set it to premise.
`Thoroughfare`	`createAndSetThoroughfare(DependentLocality dependentLocality, Premise premise, Firm firm, PostalCode postalCode)` Creates a new instance of `Thoroughfare` and set it to thoroughfare.
`boolean`	`equals(Object obj)`
`List<AddressLine>`	`getAddressLine()`
`List<Object>`	`getAny()`
`String`	`getConnector()`
`DependentLocality`	`getDependentLocality()`
`List<DependentLocality.DependentLocalityName>`	`getDependentLocalityName()`
`DependentLocality.DependentLocalityNumber`	`getDependentLocalityNumber()`
`String`	`getIndicator()`
`LargeMailUser`	`getLargeMailUser()`
`Map<QName,String>`	`getOtherAttributes()`
`PostalCode`	`getPostalCode()`
`PostalRoute`	`getPostalRoute()`
`PostBox`	`getPostBox()`
`PostOffice`	`getPostOffice()`
`Premise`	`getPremise()`
`Thoroughfare`	`getThoroughfare()`
`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`	`setAny(List<Object> any)` Sets the value of the any property Objects of the following type(s) are allowed in the list List
`void`	`setConnector(String value)`
`void`	`setDependentLocality(DependentLocality value)`
`void`	`setDependentLocalityName(List<DependentLocality.DependentLocalityName> dependentLocalityName)` Sets the value of the dependentLocalityName property Objects of the following type(s) are allowed in the list List.
`void`	`setDependentLocalityNumber(DependentLocality.DependentLocalityNumber value)`
`void`	`setIndicator(String value)`
`void`	`setLargeMailUser(LargeMailUser value)`
`void`	`setPostalCode(PostalCode value)`
`void`	`setPostalRoute(PostalRoute value)`
`void`	`setPostBox(PostBox value)`
`void`	`setPostOffice(PostOffice value)`
`void`	`setPremise(Premise value)`
`void`	`setThoroughfare(Thoroughfare value)`
`void`	`setUnderscore(String value)`
`void`	`setUsage(String value)`
`DependentLocality`	`withAddressLine(List<AddressLine> addressLine)` fluent setter
`DependentLocality`	`withAny(List<Object> any)` fluent setter
`DependentLocality`	`withConnector(String connector)` fluent setter
`DependentLocality`	`withDependentLocality(DependentLocality dependentLocality)` fluent setter
`DependentLocality`	`withDependentLocalityName(List<DependentLocality.DependentLocalityName> dependentLocalityName)` fluent setter
`DependentLocality`	`withDependentLocalityNumber(DependentLocality.DependentLocalityNumber dependentLocalityNumber)` fluent setter
`DependentLocality`	`withIndicator(String indicator)` fluent setter
`DependentLocality`	`withPostalCode(PostalCode postalCode)` fluent setter
`DependentLocality`	`withPremise(Premise premise)` fluent setter
`DependentLocality`	`withThoroughfare(Thoroughfare thoroughfare)` fluent setter
`DependentLocality`	`withUnderscore(String underscore)` fluent setter
`DependentLocality`	`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
```
  - dependentLocalityName
```
protected List<DependentLocality.DependentLocalityName> dependentLocalityName
```
  - dependentLocalityNumber
```
protected DependentLocality.DependentLocalityNumber dependentLocalityNumber
```
  - postBox
```
protected PostBox postBox
```
  - largeMailUser
```
protected LargeMailUser largeMailUser
```
  - postOffice
```
protected PostOffice postOffice
```
  - postalRoute
```
protected PostalRoute postalRoute
```
  - thoroughfare
```
protected Thoroughfare thoroughfare
```
  - premise
```
protected Premise premise
```
  - dependentLocality
```
protected DependentLocality dependentLocality
```
  - postalCode
```
protected PostalCode postalCode
```
  - any
```
protected List<Object> any
```
  - underscore
```
protected String underscore
```
  - usage
```
protected String usage
```
  - connector
```
protected String connector
```
  - indicator
```
protected String indicator
```
- Constructor Detail
  - DependentLocality
```
public DependentLocality(PostBox postBox,
                 LargeMailUser largeMailUser,
                 PostOffice postOffice,
                 PostalRoute postalRoute)
```
    Value constructor with only mandatory fields
    
    Parameters:
    postBox - required parameter
    postOffice - required parameter
    postalRoute - required parameter
    largeMailUser - required parameter
- Method Detail
  - getAddressLine
```
public List<AddressLine> getAddressLine()
```
  - getDependentLocalityName
```
public List<DependentLocality.DependentLocalityName> getDependentLocalityName()
```
  - getDependentLocalityNumber
```
public DependentLocality.DependentLocalityNumber getDependentLocalityNumber()
```
    Returns:
    possible object is DependentLocality.DependentLocalityNumber
  - setDependentLocalityNumber
```
public void setDependentLocalityNumber(DependentLocality.DependentLocalityNumber value)
```
    Parameters:
    value - allowed object is DependentLocality.DependentLocalityNumber
  - getPostBox
```
public PostBox getPostBox()
```
    Returns:
    possible object is PostBox
  - setPostBox
```
public void setPostBox(PostBox value)
```
    Parameters:
    value - allowed object is PostBox
  - getLargeMailUser
```
public LargeMailUser getLargeMailUser()
```
    Returns:
    possible object is LargeMailUser
  - setLargeMailUser
```
public void setLargeMailUser(LargeMailUser value)
```
    Parameters:
    value - allowed object is LargeMailUser
  - getPostOffice
```
public PostOffice getPostOffice()
```
    Returns:
    possible object is PostOffice
  - setPostOffice
```
public void setPostOffice(PostOffice value)
```
    Parameters:
    value - allowed object is PostOffice
  - getPostalRoute
```
public PostalRoute getPostalRoute()
```
    Returns:
    possible object is PostalRoute
  - setPostalRoute
```
public void setPostalRoute(PostalRoute value)
```
    Parameters:
    value - allowed object is PostalRoute
  - getThoroughfare
```
public Thoroughfare getThoroughfare()
```
    Returns:
    possible object is Thoroughfare
  - setThoroughfare
```
public void setThoroughfare(Thoroughfare value)
```
    Parameters:
    value - allowed object is Thoroughfare
  - getPremise
```
public Premise getPremise()
```
    Returns:
    possible object is Premise
  - setPremise
```
public void setPremise(Premise value)
```
    Parameters:
    value - allowed object is Premise
  - getDependentLocality
```
public DependentLocality getDependentLocality()
```
    Returns:
    possible object is DependentLocality
  - setDependentLocality
```
public void setDependentLocality(DependentLocality value)
```
    Parameters:
    value - allowed object is DependentLocality
  - 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
  - getConnector
```
public String getConnector()
```
    Returns:
    possible object is String
  - setConnector
```
public void setConnector(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);
  - createAndAddDependentLocalityName
```
public DependentLocality.DependentLocalityName createAndAddDependentLocalityName()
```
    Creates a new instance of DependentLocality.DependentLocalityName and adds it to dependentLocalityName. This method is a short version for: DependentLocalityName dependentLocalityName = new DependentLocalityName(); this.getDependentLocalityName().add(dependentLocalityName);
  - createAndSetDependentLocalityNumber
```
public DependentLocality.DependentLocalityNumber createAndSetDependentLocalityNumber()
```
    Creates a new instance of DependentLocality.DependentLocalityNumber and set it to dependentLocalityNumber. This method is a short version for: DependentLocalityNumber dependentLocalityNumber = new DependentLocalityNumber(); this.setDependentLocalityNumber(dependentLocalityNumber);
  - createAndSetPostBox
```
public PostBox createAndSetPostBox(PostBox.PostBoxNumber postBoxNumber)
```
    Creates a new instance of PostBox and set it to postBox. This method is a short version for: PostBox postBox = new PostBox(); this.setPostBox(postBox);
    
    Parameters:
    postBoxNumber - required parameter
  - createAndSetLargeMailUser
```
public LargeMailUser createAndSetLargeMailUser()
```
    Creates a new instance of LargeMailUser and set it to largeMailUser. This method is a short version for: LargeMailUser largeMailUser = new LargeMailUser(); this.setLargeMailUser(largeMailUser);
  - 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);
  - createAndSetPostalRoute
```
public PostalRoute createAndSetPostalRoute(List<PostalRoute.PostalRouteName> postalRouteName,
                                  PostalRoute.PostalRouteNumber postalRouteNumber)
```
    Creates a new instance of PostalRoute and set it to postalRoute. This method is a short version for: PostalRoute postalRoute = new PostalRoute(); this.setPostalRoute(postalRoute);
    
    Parameters:
    postalRouteName - required parameter
    postalRouteNumber - 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
  - createAndSetPremise
```
public Premise createAndSetPremise(Premise.PremiseLocation premiseLocation,
                          List<PremiseNumber> premiseNumber,
                          Premise.PremiseNumberRange premiseNumberRange)
```
    Creates a new instance of Premise and set it to premise. This method is a short version for: Premise premise = new Premise(); this.setPremise(premise);
    
    Parameters:
    premiseNumber - required parameter
    premiseNumberRange - required parameter
    premiseLocation - required parameter
  - createAndSetDependentLocality
```
public DependentLocality createAndSetDependentLocality(PostBox postBox,
                                              LargeMailUser largeMailUser,
                                              PostOffice postOffice,
                                              PostalRoute postalRoute)
```
    Creates a new instance of DependentLocality and set it to dependentLocality. This method is a short version for: DependentLocality dependentLocality = new DependentLocality(); this.setDependentLocality(dependentLocality);
    
    Parameters:
    postBox - required parameter
    postOffice - required parameter
    postalRoute - required parameter
    largeMailUser - required parameter
  - 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 DependentLocality 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).
  - setDependentLocalityName
```
public void setDependentLocalityName(List<DependentLocality.DependentLocalityName> dependentLocalityName)
```
    Sets the value of the dependentLocalityName 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 withDependentLocalityName(java.util.List<de.micromata.opengis.kml.v_2_2_0.xal.DependentLocality.DependentLocalityName>) instead.
    
    Parameters:
    dependentLocalityName -
  - addToDependentLocalityName
```
public DependentLocality addToDependentLocalityName(DependentLocality.DependentLocalityName dependentLocalityName)
```
    add a value to the dependentLocalityName property collection
    
    Parameters:
    dependentLocalityName - Objects of the following type are allowed in the list: DependentLocality.DependentLocalityName
    
    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 DependentLocality 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 DependentLocality withAddressLine(List<AddressLine> addressLine)
    
    fluent setter
    
    Parameters:
    addressLine - required parameter
    See Also:
    #setAddressLine(List)
    
    withDependentLocalityName
    
    public DependentLocality withDependentLocalityName(List<DependentLocality.DependentLocalityName> dependentLocalityName)
    
    fluent setter
    
    Parameters:
    dependentLocalityName - required parameter
    See Also:
    #setDependentLocalityName(List)
    
    withDependentLocalityNumber
    
    public DependentLocality withDependentLocalityNumber(DependentLocality.DependentLocalityNumber dependentLocalityNumber)
    
    fluent setter
    
    Parameters:
    dependentLocalityNumber - required parameter
    See Also:
    setDependentLocalityNumber(DependentLocalityNumber)
    
    withThoroughfare
    
    public DependentLocality withThoroughfare(Thoroughfare thoroughfare)
    
    fluent setter
    
    Parameters:
    thoroughfare - required parameter
    See Also:
    setThoroughfare(Thoroughfare)
    
    withPremise
    
    public DependentLocality withPremise(Premise premise)
    
    fluent setter
    
    Parameters:
    premise - required parameter
    See Also:
    setPremise(Premise)
    
    withDependentLocality
    
    public DependentLocality withDependentLocality(DependentLocality dependentLocality)
    
    fluent setter
    
    Parameters:
    dependentLocality - required parameter
    See Also:
    setDependentLocality(DependentLocality)
    
    withPostalCode
    
    public DependentLocality withPostalCode(PostalCode postalCode)
    
    fluent setter
    
    Parameters:
    postalCode - required parameter
    See Also:
    setPostalCode(PostalCode)
    
    withAny
    
    public DependentLocality withAny(List<Object> any)
    
    fluent setter
    
    Parameters:
    any - required parameter
    See Also:
    #setAny(List

Class DependentLocality

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

addressLine

dependentLocalityName

dependentLocalityNumber

postBox

largeMailUser

postOffice

postalRoute

thoroughfare

premise

dependentLocality

postalCode

any

underscore

usage

connector

indicator

Constructor Detail

DependentLocality

Method Detail

getAddressLine

getDependentLocalityName

getDependentLocalityNumber

setDependentLocalityNumber

getPostBox

setPostBox

getLargeMailUser

setLargeMailUser

getPostOffice

setPostOffice

getPostalRoute

setPostalRoute

getThoroughfare

setThoroughfare

getPremise

setPremise

getDependentLocality

setDependentLocality

getPostalCode

setPostalCode

getAny

getUnderscore

setUnderscore

getUsage

setUsage

getConnector

setConnector

getIndicator

setIndicator

getOtherAttributes

hashCode

equals

createAndAddAddressLine

createAndAddDependentLocalityName

createAndSetDependentLocalityNumber

createAndSetPostBox

createAndSetLargeMailUser

createAndSetPostOffice

createAndSetPostalRoute

createAndSetThoroughfare

createAndSetPremise

createAndSetDependentLocality

createAndSetPostalCode

setAddressLine

addToAddressLine

setDependentLocalityName

addToDependentLocalityName

setAny

addToAny

withAddressLine

withDependentLocalityName

withDependentLocalityNumber

withThoroughfare

withPremise