PostBox (a Java API for Kml 2.2.1 API)

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

All Implemented Interfaces:: Cloneable

public class PostBox
extends Object
implements Cloneable

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PostBox.PostBoxNumber`
`static class`	`PostBox.PostBoxNumberExtension`
`static class`	`PostBox.PostBoxNumberPrefix`
`static class`	`PostBox.PostBoxNumberSuffix`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<AddressLine>`	`addressLine`
`protected List<Object>`	`any`
`protected Firm`	`firm`
`protected String`	`indicator`
`protected PostalCode`	`postalCode`
`protected PostBox.PostBoxNumber`	`postBoxNumber`
`protected PostBox.PostBoxNumberExtension`	`postBoxNumberExtension`
`protected PostBox.PostBoxNumberPrefix`	`postBoxNumberPrefix`
`protected PostBox.PostBoxNumberSuffix`	`postBoxNumberSuffix`
`protected String`	`underscore`

Constructor Summary

Constructors
Constructor and Description

PostBox(PostBox.PostBoxNumber postBoxNumber)
Value constructor with only mandatory fields

Constructors
Constructor and Description
`PostBox(PostBox.PostBoxNumber postBoxNumber)` Value constructor with only mandatory fields

Method Summary

Methods
Modifier and Type	Method and Description
`PostBox`	`addToAddressLine(AddressLine addressLine)` add a value to the addressLine property collection
`PostBox`	`addToAny(Object any)` add a value to the any property collection
`PostBox`	`clone()`
`AddressLine`	`createAndAddAddressLine()` Creates a new instance of `AddressLine` and adds it to addressLine.
`Firm`	`createAndSetFirm()` Creates a new instance of `Firm` and set it to firm.
`PostalCode`	`createAndSetPostalCode()` Creates a new instance of `PostalCode` and set it to postalCode.
`PostBox.PostBoxNumber`	`createAndSetPostBoxNumber()` Creates a new instance of `PostBox.PostBoxNumber` and set it to postBoxNumber.
`PostBox.PostBoxNumberExtension`	`createAndSetPostBoxNumberExtension()` Creates a new instance of `PostBox.PostBoxNumberExtension` and set it to postBoxNumberExtension.
`PostBox.PostBoxNumberPrefix`	`createAndSetPostBoxNumberPrefix()` Creates a new instance of `PostBox.PostBoxNumberPrefix` and set it to postBoxNumberPrefix.
`PostBox.PostBoxNumberSuffix`	`createAndSetPostBoxNumberSuffix()` Creates a new instance of `PostBox.PostBoxNumberSuffix` and set it to postBoxNumberSuffix.
`boolean`	`equals(Object obj)`
`List<AddressLine>`	`getAddressLine()`
`List<Object>`	`getAny()`
`Firm`	`getFirm()`
`String`	`getIndicator()`
`Map<QName,String>`	`getOtherAttributes()`
`PostalCode`	`getPostalCode()`
`PostBox.PostBoxNumber`	`getPostBoxNumber()`
`PostBox.PostBoxNumberExtension`	`getPostBoxNumberExtension()`
`PostBox.PostBoxNumberPrefix`	`getPostBoxNumberPrefix()`
`PostBox.PostBoxNumberSuffix`	`getPostBoxNumberSuffix()`
`String`	`getUnderscore()`
`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`	`setFirm(Firm value)`
`void`	`setIndicator(String value)`
`void`	`setPostalCode(PostalCode value)`
`void`	`setPostBoxNumber(PostBox.PostBoxNumber value)`
`void`	`setPostBoxNumberExtension(PostBox.PostBoxNumberExtension value)`
`void`	`setPostBoxNumberPrefix(PostBox.PostBoxNumberPrefix value)`
`void`	`setPostBoxNumberSuffix(PostBox.PostBoxNumberSuffix value)`
`void`	`setUnderscore(String value)`
`PostBox`	`withAddressLine(List<AddressLine> addressLine)` fluent setter
`PostBox`	`withAny(List<Object> any)` fluent setter
`PostBox`	`withFirm(Firm firm)` fluent setter
`PostBox`	`withIndicator(String indicator)` fluent setter
`PostBox`	`withPostalCode(PostalCode postalCode)` fluent setter
`PostBox`	`withPostBoxNumberExtension(PostBox.PostBoxNumberExtension postBoxNumberExtension)` fluent setter
`PostBox`	`withPostBoxNumberPrefix(PostBox.PostBoxNumberPrefix postBoxNumberPrefix)` fluent setter
`PostBox`	`withPostBoxNumberSuffix(PostBox.PostBoxNumberSuffix postBoxNumberSuffix)` fluent setter
`PostBox`	`withUnderscore(String underscore)` fluent setter

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

- Field Detail
  - addressLine
```
protected List<AddressLine> addressLine
```
  - postBoxNumber
```
protected PostBox.PostBoxNumber postBoxNumber
```
  - postBoxNumberPrefix
```
protected PostBox.PostBoxNumberPrefix postBoxNumberPrefix
```
  - postBoxNumberSuffix
```
protected PostBox.PostBoxNumberSuffix postBoxNumberSuffix
```
  - postBoxNumberExtension
```
protected PostBox.PostBoxNumberExtension postBoxNumberExtension
```
  - firm
```
protected Firm firm
```
  - postalCode
```
protected PostalCode postalCode
```
  - any
```
protected List<Object> any
```
  - underscore
```
protected String underscore
```
  - indicator
```
protected String indicator
```
- Constructor Detail
  - PostBox
```
public PostBox(PostBox.PostBoxNumber postBoxNumber)
```
    Value constructor with only mandatory fields
    
    Parameters:
    postBoxNumber - required parameter
- Method Detail
  - getAddressLine
```
public List<AddressLine> getAddressLine()
```
  - getPostBoxNumber
```
public PostBox.PostBoxNumber getPostBoxNumber()
```
    Returns:
    possible object is PostBox.PostBoxNumber
  - setPostBoxNumber
```
public void setPostBoxNumber(PostBox.PostBoxNumber value)
```
    Parameters:
    value - allowed object is PostBox.PostBoxNumber
  - getPostBoxNumberPrefix
```
public PostBox.PostBoxNumberPrefix getPostBoxNumberPrefix()
```
    Returns:
    possible object is PostBox.PostBoxNumberPrefix
  - setPostBoxNumberPrefix
```
public void setPostBoxNumberPrefix(PostBox.PostBoxNumberPrefix value)
```
    Parameters:
    value - allowed object is PostBox.PostBoxNumberPrefix
  - getPostBoxNumberSuffix
```
public PostBox.PostBoxNumberSuffix getPostBoxNumberSuffix()
```
    Returns:
    possible object is PostBox.PostBoxNumberSuffix
  - setPostBoxNumberSuffix
```
public void setPostBoxNumberSuffix(PostBox.PostBoxNumberSuffix value)
```
    Parameters:
    value - allowed object is PostBox.PostBoxNumberSuffix
  - getPostBoxNumberExtension
```
public PostBox.PostBoxNumberExtension getPostBoxNumberExtension()
```
    Returns:
    possible object is PostBox.PostBoxNumberExtension
  - setPostBoxNumberExtension
```
public void setPostBoxNumberExtension(PostBox.PostBoxNumberExtension value)
```
    Parameters:
    value - allowed object is PostBox.PostBoxNumberExtension
  - getFirm
```
public Firm getFirm()
```
    Returns:
    possible object is Firm
  - setFirm
```
public void setFirm(Firm value)
```
    Parameters:
    value - allowed object is Firm
  - 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
  - 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);
  - createAndSetPostBoxNumber
```
public PostBox.PostBoxNumber createAndSetPostBoxNumber()
```
    Creates a new instance of PostBox.PostBoxNumber and set it to postBoxNumber. This method is a short version for: PostBoxNumber postBoxNumber = new PostBoxNumber(); this.setPostBoxNumber(postBoxNumber);
  - createAndSetPostBoxNumberPrefix
```
public PostBox.PostBoxNumberPrefix createAndSetPostBoxNumberPrefix()
```
    Creates a new instance of PostBox.PostBoxNumberPrefix and set it to postBoxNumberPrefix. This method is a short version for: PostBoxNumberPrefix postBoxNumberPrefix = new PostBoxNumberPrefix(); this.setPostBoxNumberPrefix(postBoxNumberPrefix);
  - createAndSetPostBoxNumberSuffix
```
public PostBox.PostBoxNumberSuffix createAndSetPostBoxNumberSuffix()
```
    Creates a new instance of PostBox.PostBoxNumberSuffix and set it to postBoxNumberSuffix. This method is a short version for: PostBoxNumberSuffix postBoxNumberSuffix = new PostBoxNumberSuffix(); this.setPostBoxNumberSuffix(postBoxNumberSuffix);
  - createAndSetPostBoxNumberExtension
```
public PostBox.PostBoxNumberExtension createAndSetPostBoxNumberExtension()
```
    Creates a new instance of PostBox.PostBoxNumberExtension and set it to postBoxNumberExtension. This method is a short version for: PostBoxNumberExtension postBoxNumberExtension = new PostBoxNumberExtension(); this.setPostBoxNumberExtension(postBoxNumberExtension);
  - createAndSetFirm
```
public Firm createAndSetFirm()
```
    Creates a new instance of Firm and set it to firm. This method is a short version for: Firm firm = new Firm(); this.setFirm(firm);
  - 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 PostBox 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).
  - 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 PostBox 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 PostBox withAddressLine(List<AddressLine> addressLine)
    
    fluent setter
    
    Parameters:
    addressLine - required parameter
    See Also:
    #setAddressLine(List)
    
    withPostBoxNumberPrefix
    
    public PostBox withPostBoxNumberPrefix(PostBox.PostBoxNumberPrefix postBoxNumberPrefix)
    
    fluent setter
    
    Parameters:
    postBoxNumberPrefix - required parameter
    See Also:
    setPostBoxNumberPrefix(PostBoxNumberPrefix)
    
    withPostBoxNumberSuffix
    
    public PostBox withPostBoxNumberSuffix(PostBox.PostBoxNumberSuffix postBoxNumberSuffix)
    
    fluent setter
    
    Parameters:
    postBoxNumberSuffix - required parameter
    See Also:
    setPostBoxNumberSuffix(PostBoxNumberSuffix)
    
    withPostBoxNumberExtension
    
    public PostBox withPostBoxNumberExtension(PostBox.PostBoxNumberExtension postBoxNumberExtension)
    
    fluent setter
    
    Parameters:
    postBoxNumberExtension - required parameter
    See Also:
    setPostBoxNumberExtension(PostBoxNumberExtension)
    
    withFirm
    
    public PostBox withFirm(Firm firm)
    
    fluent setter
    
    Parameters:
    firm - required parameter
    See Also:
    setFirm(Firm)
    
    withPostalCode
    
    public PostBox withPostalCode(PostalCode postalCode)
    
    fluent setter
    
    Parameters:
    postalCode - required parameter
    See Also:
    setPostalCode(PostalCode)
    
    withAny
    
    public PostBox withAny(List<Object> any)
    
    fluent setter
    
    Parameters:
    any - required parameter
    See Also:
    #setAny(List

Class PostBox

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

addressLine

postBoxNumber

postBoxNumberPrefix

postBoxNumberSuffix

postBoxNumberExtension

firm

postalCode

any

underscore

indicator

Constructor Detail

PostBox

Method Detail

getAddressLine

getPostBoxNumber

setPostBoxNumber

getPostBoxNumberPrefix

setPostBoxNumberPrefix

getPostBoxNumberSuffix

setPostBoxNumberSuffix

getPostBoxNumberExtension

setPostBoxNumberExtension

getFirm

setFirm

getPostalCode

setPostalCode

getAny

getUnderscore

setUnderscore

getIndicator

setIndicator

getOtherAttributes

hashCode

equals

createAndAddAddressLine

createAndSetPostBoxNumber

createAndSetPostBoxNumberPrefix

createAndSetPostBoxNumberSuffix

createAndSetPostBoxNumberExtension

createAndSetFirm

createAndSetPostalCode

setAddressLine

addToAddressLine

setAny

addToAny

withAddressLine

withPostBoxNumberPrefix

withPostBoxNumberSuffix

withPostBoxNumberExtension

withFirm

withPostalCode

withAny

withUnderscore

withIndicator

clone