Address ("The CQ5 Quickstart and Web Application.")

java.lang.Object
- SlingAdaptable
- - com.adobe.cq.address.api.Address

All Implemented Interfaces:

Comparable<Address>
```
public final class Address
extends SlingAdaptable
implements Comparable<Address>
```
Represents an address. Use AddressManager to create address objects.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CITY` Property describing the address city.
`static String`	`COUNTRY` Property describing the country.
`static String`	`FIRST_NAME` Property describing the address first name.
`static String`	`LABEL` Property describing the address label.
`static String`	`LAST_NAME` Property describing the address last name.
`static String`	`PARAM_ADDRESS_PATH` Address path parameter name.
`static String`	`STATE` Property describing the state (mainly used in the U.S.)
`static String`	`STREET_LINE1` Property describing the 1st line of the address street.
`static String`	`STREET_LINE2` Property describing the 2nd line of the address street.
`static String`	`TITLE` Property describing the address title.
`static String`	`ZIP_CODE` Property describing the zip code.

Constructor Summary

Constructors
Constructor and Description

Address(Resource res)
Creates an address object.

Constructors
Constructor and Description
`Address(Resource res)` Creates an address object.

Method Summary

Methods
Modifier and Type	Method and Description
`<AdapterType> AdapterType`	`adaptTo(Class<AdapterType> type)`
`int`	`compareTo(Address address)` Compares the current address with another one for sorting.
`String`	`getCity()` Returns the address city.
`String`	`getCountry()` Returns the address country.
`String`	`getFirstName()` Returns the address first name.
`String`	`getLabel()` Returns the address label.
`String`	`getLastName()` Returns the address last name.
`String`	`getPath()` Returns the address path in the repository.
`ValueMap`	`getProperties()` Returns the address properties.
`<T> T`	`getProperty(String key, Class<T> type)` Returns a named address property converted to a given type.
`<T> T`	`getProperty(String key, T defaultValue)` Returns a named address property or a default value if the property can not be retrieved.
`String`	`getState()` Returns the address state.
`String`	`getStreetLine1()` Returns the 1st line of the address street.
`String`	`getStreetLine2()` Returns the 2nd line of the address street.
`String`	`getTitle()` Returns the address title.
`String`	`getZipCode()` Returns the address zip code.
`void`	`setCity(String city)` Sets the address city.
`void`	`setCountry(String country)` Sets the address country.
`void`	`setFirstName(String firstName)` Sets the address first name.
`void`	`setLabel(String label)` Sets the address label.
`void`	`setLastName(String lastName)` Sets the address last name.
`void`	`setProperties(Map<String,Object> properties)` Sets the address properties.
`void`	`setProperty(String key, Object value)` Sets an address property.
`void`	`setState(String state)` Sets the address state.
`void`	`setStreetLine1(String streetLine1)` Sets the 1st line of the address street.
`void`	`setStreetLine2(String streetLine1)` Sets the 2nd line of the address street.
`void`	`setTitle(String title)` Sets the address title.
`void`	`setZipCode(String zipCode)` Sets the address zip code.

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

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - LABEL
```
public static final String LABEL
```
    Property describing the address label. Can be used to describe the address, e.g. "my winter appartment"
    
    See Also:
    Constant Field Values
  - TITLE
```
public static final String TITLE
```
    Property describing the address title. E.g.: Mr.
    
    See Also:
    Constant Field Values
  - FIRST_NAME
```
public static final String FIRST_NAME
```
    Property describing the address first name.
    
    See Also:
    Constant Field Values
  - LAST_NAME
```
public static final String LAST_NAME
```
    Property describing the address last name.
    
    See Also:
    Constant Field Values
  - STREET_LINE1
```
public static final String STREET_LINE1
```
    Property describing the 1st line of the address street.
    
    See Also:
    Constant Field Values
  - STREET_LINE2
```
public static final String STREET_LINE2
```
    Property describing the 2nd line of the address street.
    
    See Also:
    Constant Field Values
  - CITY
```
public static final String CITY
```
    Property describing the address city.
    
    See Also:
    Constant Field Values
  - ZIP_CODE
```
public static final String ZIP_CODE
```
    Property describing the zip code.
    
    See Also:
    Constant Field Values
  - STATE
```
public static final String STATE
```
    Property describing the state (mainly used in the U.S.)
    
    See Also:
    Constant Field Values
  - COUNTRY
```
public static final String COUNTRY
```
    Property describing the country.
    
    See Also:
    Constant Field Values
  - PARAM_ADDRESS_PATH
```
public static final String PARAM_ADDRESS_PATH
```
    Address path parameter name.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - Address
```
public Address(Resource res)
```
    Creates an address object.
    
    Parameters:
    res - The resource that represents the address.
- Method Detail
  - getPath
```
public String getPath()
```
    Returns the address path in the repository.
    
    Returns:
    The address path.
  - getProperties
```
public ValueMap getProperties()
```
    Returns the address properties.
    
    Returns:
    The address properties as a ValueMap.
  - getProperty
```
public <T> T getProperty(String key,
                Class<T> type)
```
    Returns a named address property converted to a given type.
    
    Parameters:
    key - The name of the property
    type - The type to which the property should be converted.
    
    Returns:
    The named value converted to type T.
  - getProperty
```
public <T> T getProperty(String key,
                T defaultValue)
```
    Returns a named address property or a default value if the property can not be retrieved.
    
    Parameters:
    key - The name of the property
    defaultValue - The default value to use if the named property does not exist or cannot be converted to the requested type. The default value is also used to define the type to convert the value to. If this is null any existing property is not converted.
    
    Returns:
    The named value converted to type T or the default value if non existing or can't be converted.
  - setProperties
```
public void setProperties(Map<String,Object> properties)
                   throws AddressException
```
    Sets the address properties. All the properties are replaced with the existing ones.
    
    Parameters:
    properties - The new address properties.
    
    Throws:
    
    AddressException - if persisting the properties fails.
  - setProperty
```
public void setProperty(String key,
               Object value)
                 throws AddressException
```
    Sets an address property.
    
    Parameters:
    key - The name of the property
    value - The value of the property
    
    Throws:
    
    AddressException - if persisting the property fails.
  - getLabel
```
public String getLabel()
```
    Returns the address label.
  - setLabel
```
public void setLabel(String label)
              throws AddressException
```
    Sets the address label.
    
    Throws:
    
    AddressException
  - getTitle
```
public String getTitle()
```
    Returns the address title.
  - setTitle
```
public void setTitle(String title)
              throws AddressException
```
    Sets the address title.
    
    Throws:
    
    AddressException
  - getFirstName
```
public String getFirstName()
```
    Returns the address first name.
  - setFirstName
```
public void setFirstName(String firstName)
                  throws AddressException
```
    Sets the address first name.
    
    Throws:
    
    AddressException
  - getLastName
```
public String getLastName()
```
    Returns the address last name.
  - setLastName
```
public void setLastName(String lastName)
                 throws AddressException
```
    Sets the address last name.
    
    Throws:
    
    AddressException
  - getStreetLine1
```
public String getStreetLine1()
```
    Returns the 1st line of the address street.
  - setStreetLine1
```
public void setStreetLine1(String streetLine1)
                    throws AddressException
```
    Sets the 1st line of the address street.
    
    Throws:
    
    AddressException
  - getStreetLine2
```
public String getStreetLine2()
```
    Returns the 2nd line of the address street.
  - setStreetLine2
```
public void setStreetLine2(String streetLine1)
                    throws AddressException
```
    Sets the 2nd line of the address street.
    
    Throws:
    
    AddressException
  - getCity
```
public String getCity()
```
    Returns the address city.
  - setCity
```
public void setCity(String city)
             throws AddressException
```
    Sets the address city.
    
    Throws:
    
    AddressException
  - getZipCode
```
public String getZipCode()
```
    Returns the address zip code.
  - setZipCode
```
public void setZipCode(String zipCode)
                throws AddressException
```
    Sets the address zip code.
    
    Throws:
    
    AddressException
  - getState
```
public String getState()
```
    Returns the address state.
  - setState
```
public void setState(String state)
              throws AddressException
```
    Sets the address state.
    
    Throws:
    
    AddressException
  - getCountry
```
public String getCountry()
```
    Returns the address country.
  - setCountry
```
public void setCountry(String country)
                throws AddressException
```
    Sets the address country.
    
    Throws:
    
    AddressException
  - compareTo
```
public int compareTo(Address address)
```
    Compares the current address with another one for sorting. The comparison is based on the last name if available, on the address path otherwise.
    
    Parameters:
    address - The address which has to be compared with the current one
    
    Returns:
    a negative integer, zero, or a positive integer as this address is less than, equal to, or greater than the specified one.
    See Also:
    Comparable.compareTo(Object)
  - adaptTo
```
public <AdapterType> AdapterType adaptTo(Class<AdapterType> type)
```

Class Address

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Comparable

Field Detail

LABEL

TITLE

FIRST_NAME

LAST_NAME

STREET_LINE1

STREET_LINE2

CITY

ZIP_CODE

STATE

COUNTRY

PARAM_ADDRESS_PATH

Constructor Detail

Address

Method Detail

getPath

getProperties

getProperty

getProperty

setProperties

setProperty

getLabel

setLabel

getTitle

setTitle

getFirstName

setFirstName

getLastName

setLastName

getStreetLine1

setStreetLine1

getStreetLine2

setStreetLine2

getCity

setCity

getZipCode

setZipCode

getState

setState

getCountry

setCountry

compareTo

adaptTo