CommonPAFAddress (Client Library 1.0.0-RC4 API)

java.lang.Object
- au.org.consumerdatastandards.client.model.CommonPAFAddress

```
public class CommonPAFAddress
extends Object
```
Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf)

Constructor Summary

Constructors
Constructor and Description

CommonPAFAddress()

Constructors
Constructor and Description
`CommonPAFAddress()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getBuildingName1()` Building/Property name 1
`String`	`getBuildingName2()` Building/Property name 2
`String`	`getDpid()` Unique identifier for an address as defined by Australia Post.
`String`	`getFlatUnitNumber()` Unit number (including suffix, if applicable)
`String`	`getFlatUnitType()` Type of flat or unit for the address
`String`	`getFloorLevelNumber()` Floor or level number (including alpha characters)
`String`	`getFloorLevelType()` Type of floor or level for the address
`String`	`getLocalityName()` Full name of locality
`String`	`getLotNumber()` Allotment number for the address
`Integer`	`getPostalDeliveryNumber()` Postal delivery number if the address is a postal delivery type
`String`	`getPostalDeliveryNumberPrefix()` Postal delivery number prefix related to the postal delivery number
`String`	`getPostalDeliveryNumberSuffix()` Postal delivery number suffix related to the postal delivery number
`String`	`getPostalDeliveryType()` Postal delivery type.
`String`	`getPostcode()` Postcode for the locality
`String`	`getState()` State in which the address belongs.
`String`	`getStreetName()` The name of the street
`String`	`getStreetSuffix()` The street type suffix.
`String`	`getStreetType()` The street type.
`Integer`	`getThoroughfareNumber1()` Thoroughfare number for a property (first number in a property ranged address)
`String`	`getThoroughfareNumber1Suffix()` Suffix for the thoroughfare number.
`Integer`	`getThoroughfareNumber2()` Second thoroughfare number (only used if the property has a ranged address eg 23-25)
`String`	`getThoroughfareNumber2Suffix()` Suffix for the second thoroughfare number.
`int`	`hashCode()`
`void`	`setBuildingName1(String buildingName1)`
`void`	`setBuildingName2(String buildingName2)`
`void`	`setDpid(String dpid)`
`void`	`setFlatUnitNumber(String flatUnitNumber)`
`void`	`setFlatUnitType(String flatUnitType)`
`void`	`setFloorLevelNumber(String floorLevelNumber)`
`void`	`setFloorLevelType(String floorLevelType)`
`void`	`setLocalityName(String localityName)`
`void`	`setLotNumber(String lotNumber)`
`void`	`setPostalDeliveryNumber(Integer postalDeliveryNumber)`
`void`	`setPostalDeliveryNumberPrefix(String postalDeliveryNumberPrefix)`
`void`	`setPostalDeliveryNumberSuffix(String postalDeliveryNumberSuffix)`
`void`	`setPostalDeliveryType(String postalDeliveryType)`
`void`	`setPostcode(String postcode)`
`void`	`setState(String state)`
`void`	`setStreetName(String streetName)`
`void`	`setStreetSuffix(String streetSuffix)`
`void`	`setStreetType(String streetType)`
`void`	`setThoroughfareNumber1(Integer thoroughfareNumber1)`
`void`	`setThoroughfareNumber1Suffix(String thoroughfareNumber1Suffix)`
`void`	`setThoroughfareNumber2(Integer thoroughfareNumber2)`
`void`	`setThoroughfareNumber2Suffix(String thoroughfareNumber2Suffix)`
`String`	`toString()`

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

- Constructor Detail
  - CommonPAFAddress
```
public CommonPAFAddress()
```
- Method Detail
  - getBuildingName1
```
public String getBuildingName1()
```
    Building/Property name 1
    
    Returns:
    
    buildingName1
  - setBuildingName1
```
public void setBuildingName1(String buildingName1)
```
  - getBuildingName2
```
public String getBuildingName2()
```
    Building/Property name 2
    
    Returns:
    
    buildingName2
  - setBuildingName2
```
public void setBuildingName2(String buildingName2)
```
  - getDpid
```
public String getDpid()
```
    Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier
    
    Returns:
    
    dpid
  - setDpid
```
public void setDpid(String dpid)
```
  - getFlatUnitNumber
```
public String getFlatUnitNumber()
```
    Unit number (including suffix, if applicable)
    
    Returns:
    
    flatUnitNumber
  - setFlatUnitNumber
```
public void setFlatUnitNumber(String flatUnitNumber)
```
  - getFlatUnitType
```
public String getFlatUnitType()
```
    Type of flat or unit for the address
    
    Returns:
    
    flatUnitType
  - setFlatUnitType
```
public void setFlatUnitType(String flatUnitType)
```
  - getFloorLevelNumber
```
public String getFloorLevelNumber()
```
    Floor or level number (including alpha characters)
    
    Returns:
    
    floorLevelNumber
  - setFloorLevelNumber
```
public void setFloorLevelNumber(String floorLevelNumber)
```
  - getFloorLevelType
```
public String getFloorLevelType()
```
    Type of floor or level for the address
    
    Returns:
    
    floorLevelType
  - setFloorLevelType
```
public void setFloorLevelType(String floorLevelType)
```
  - getLocalityName
```
public String getLocalityName()
```
    Full name of locality
    
    Returns:
    
    localityName
  - setLocalityName
```
public void setLocalityName(String localityName)
```
  - getLotNumber
```
public String getLotNumber()
```
    Allotment number for the address
    
    Returns:
    
    lotNumber
  - setLotNumber
```
public void setLotNumber(String lotNumber)
```
  - getPostalDeliveryNumber
```
public Integer getPostalDeliveryNumber()
```
    Postal delivery number if the address is a postal delivery type
    
    Returns:
    
    postalDeliveryNumber
  - setPostalDeliveryNumber
```
public void setPostalDeliveryNumber(Integer postalDeliveryNumber)
```
  - getPostalDeliveryNumberPrefix
```
public String getPostalDeliveryNumberPrefix()
```
    Postal delivery number prefix related to the postal delivery number
    
    Returns:
    
    postalDeliveryNumberPrefix
  - setPostalDeliveryNumberPrefix
```
public void setPostalDeliveryNumberPrefix(String postalDeliveryNumberPrefix)
```
  - getPostalDeliveryNumberSuffix
```
public String getPostalDeliveryNumberSuffix()
```
    Postal delivery number suffix related to the postal delivery number
    
    Returns:
    
    postalDeliveryNumberSuffix
  - setPostalDeliveryNumberSuffix
```
public void setPostalDeliveryNumberSuffix(String postalDeliveryNumberSuffix)
```
  - getPostalDeliveryType
```
public String getPostalDeliveryType()
```
    Postal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file
    
    Returns:
    
    postalDeliveryType
  - setPostalDeliveryType
```
public void setPostalDeliveryType(String postalDeliveryType)
```
  - getPostcode
```
public String getPostcode()
```
    Postcode for the locality
    
    Returns:
    
    postcode
  - setPostcode
```
public void setPostcode(String postcode)
```
  - getState
```
public String getState()
```
    State in which the address belongs. Valid enumeration defined by Australia Post PAF code file [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT
    
    Returns:
    
    state
  - setState
```
public void setState(String state)
```
  - getStreetName
```
public String getStreetName()
```
    The name of the street
    
    Returns:
    
    streetName
  - setStreetName
```
public void setStreetName(String streetName)
```
  - getStreetSuffix
```
public String getStreetSuffix()
```
    The street type suffix. Valid enumeration defined by Australia Post PAF code file
    
    Returns:
    
    streetSuffix
  - setStreetSuffix
```
public void setStreetSuffix(String streetSuffix)
```
  - getStreetType
```
public String getStreetType()
```
    The street type. Valid enumeration defined by Australia Post PAF code file
    
    Returns:
    
    streetType
  - setStreetType
```
public void setStreetType(String streetType)
```
  - getThoroughfareNumber1
```
public Integer getThoroughfareNumber1()
```
    Thoroughfare number for a property (first number in a property ranged address)
    
    Returns:
    
    thoroughfareNumber1
  - setThoroughfareNumber1
```
public void setThoroughfareNumber1(Integer thoroughfareNumber1)
```
  - getThoroughfareNumber1Suffix
```
public String getThoroughfareNumber1Suffix()
```
    Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated
    
    Returns:
    
    thoroughfareNumber1Suffix
  - setThoroughfareNumber1Suffix
```
public void setThoroughfareNumber1Suffix(String thoroughfareNumber1Suffix)
```
  - getThoroughfareNumber2
```
public Integer getThoroughfareNumber2()
```
    Second thoroughfare number (only used if the property has a ranged address eg 23-25)
    
    Returns:
    
    thoroughfareNumber2
  - setThoroughfareNumber2
```
public void setThoroughfareNumber2(Integer thoroughfareNumber2)
```
  - getThoroughfareNumber2Suffix
```
public String getThoroughfareNumber2Suffix()
```
    Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated
    
    Returns:
    
    thoroughfareNumber2Suffix
  - setThoroughfareNumber2Suffix
```
public void setThoroughfareNumber2Suffix(String thoroughfareNumber2Suffix)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CommonPAFAddress

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CommonPAFAddress

Method Detail

getBuildingName1

setBuildingName1

getBuildingName2

setBuildingName2

getDpid

setDpid

getFlatUnitNumber

setFlatUnitNumber

getFlatUnitType

setFlatUnitType

getFloorLevelNumber

setFloorLevelNumber

getFloorLevelType

setFloorLevelType

getLocalityName

setLocalityName

getLotNumber

setLotNumber

getPostalDeliveryNumber

setPostalDeliveryNumber

getPostalDeliveryNumberPrefix

setPostalDeliveryNumberPrefix

getPostalDeliveryNumberSuffix

setPostalDeliveryNumberSuffix

getPostalDeliveryType

setPostalDeliveryType

getPostcode

setPostcode

getState

setState

getStreetName

setStreetName

getStreetSuffix

setStreetSuffix

getStreetType

setStreetType

getThoroughfareNumber1

setThoroughfareNumber1

getThoroughfareNumber1Suffix

setThoroughfareNumber1Suffix

getThoroughfareNumber2

setThoroughfareNumber2

getThoroughfareNumber2Suffix

setThoroughfareNumber2Suffix

equals

hashCode

toString