com.adobe.cq.address.api

Class Address

java.lang.Object

org.apache.sling.api.adapter.SlingAdaptable

com.adobe.cq.address.api.Address

All Implemented Interfaces:

java.lang.Comparable<Address>, Adaptable

Deprecated.

As of AEM 6.4

@Deprecated
public final class Address
extends SlingAdaptable
implements java.lang.Comparable<Address>

Represents an address. Use AddressManager to create address objects.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class org.apache.sling.api.adapter.SlingAdaptable

setAdapterManager, unsetAdapterManager

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LABEL

public static final java.lang.String LABEL

Deprecated.

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 java.lang.String TITLE

Deprecated.

Property describing the address title. E.g.: Mr.

See Also:

Constant Field Values

FIRST_NAME

public static final java.lang.String FIRST_NAME

Deprecated.

Property describing the address first name.

See Also:

Constant Field Values

LAST_NAME

public static final java.lang.String LAST_NAME

Deprecated.

Property describing the address last name.

See Also:

Constant Field Values

STREET_LINE1

public static final java.lang.String STREET_LINE1

Deprecated.

Property describing the 1st line of the address street.

See Also:

Constant Field Values

STREET_LINE2

public static final java.lang.String STREET_LINE2

Deprecated.

Property describing the 2nd line of the address street.

See Also:

Constant Field Values

CITY

public static final java.lang.String CITY

Deprecated.

Property describing the address city.

See Also:

Constant Field Values

ZIP_CODE

public static final java.lang.String ZIP_CODE

Deprecated.

Property describing the zip code.

See Also:

Constant Field Values

STATE

public static final java.lang.String STATE

Deprecated.

Property describing the state (mainly used in the U.S.)

See Also:

Constant Field Values

COUNTRY

public static final java.lang.String COUNTRY

Deprecated.

Property describing the country.

See Also:

Constant Field Values

PARAM_ADDRESS_PATH

public static final java.lang.String PARAM_ADDRESS_PATH

Deprecated.

Address path parameter name.

See Also:

Constant Field Values

Constructor Detail

Address

public Address(Resource res)

Deprecated.

Creates an address object.

Parameters:

res - The resource that represents the address.

Method Detail

getPath

public java.lang.String getPath()

Deprecated.

Returns the address path in the repository.

Returns:

The address path.

getProperties

public ValueMap getProperties()

Deprecated.

Returns the address properties.

Returns:

The address properties as a ValueMap.

getProperty

public <T> T getProperty(java.lang.String key,
                         java.lang.Class<T> type)

Deprecated.

Returns a named address property converted to a given type.

Type Parameters:

T - The class of the 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(java.lang.String key,
                         T defaultValue)

Deprecated.

Returns a named address property or a default value if the property can not be retrieved.

Type Parameters:

T - The class of the type

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(java.util.Map<java.lang.String,java.lang.Object> properties)
                   throws AddressException

Deprecated.

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(java.lang.String key,
                        java.lang.Object value)
                 throws AddressException

Deprecated.

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 java.lang.String getLabel()

Deprecated.

Returns the address label.

Returns:

the address label

setLabel

public void setLabel(java.lang.String label)
              throws AddressException

Deprecated.

Sets the address label.

Parameters:

label - The address label

Throws:

AddressException - if persisting fails.

getTitle

public java.lang.String getTitle()

Deprecated.

Returns the address title.

Returns:

the address title

setTitle

public void setTitle(java.lang.String title)
              throws AddressException

Deprecated.

Sets the address title.

Parameters:

title - The address title

Throws:

AddressException - if persisting fails.

getFirstName

public java.lang.String getFirstName()

Deprecated.

Returns the address first name.

Returns:

the address first name

setFirstName

public void setFirstName(java.lang.String firstName)
                  throws AddressException

Deprecated.

Sets the address first name.

Parameters:

firstName - The address first name

Throws:

AddressException - if persisting fails.

getLastName

public java.lang.String getLastName()

Deprecated.

Returns the address last name.

Returns:

the address last name

setLastName

public void setLastName(java.lang.String lastName)
                 throws AddressException

Deprecated.

Sets the address last name.

Parameters:

lastName - The address last name

Throws:

AddressException - if persisting fails.

getStreetLine1

public java.lang.String getStreetLine1()

Deprecated.

Returns the 1st line of the address street.

Returns:

the 1st line of the address street

setStreetLine1

public void setStreetLine1(java.lang.String streetLine1)
                    throws AddressException

Deprecated.

Sets the 1st line of the address street.

Parameters:

streetLine1 - The address 1st line

Throws:

AddressException - if persisting fails.

getStreetLine2

public java.lang.String getStreetLine2()

Deprecated.

Returns the 2nd line of the address street.

Returns:

the 2nd line of the address street

setStreetLine2

public void setStreetLine2(java.lang.String streetLine2)
                    throws AddressException

Deprecated.

Sets the 2nd line of the address street.

Parameters:

streetLine2 - The address 2nd line

Throws:

AddressException - if persisting fails.

getCity

public java.lang.String getCity()

Deprecated.

Returns the address city.

Returns:

the address city

setCity

public void setCity(java.lang.String city)
             throws AddressException

Deprecated.

Sets the address city.

Parameters:

city - The address city

Throws:

AddressException - if persisting fails.

getZipCode

public java.lang.String getZipCode()

Deprecated.

Returns the address zip code.

Returns:

the address zip code

setZipCode

public void setZipCode(java.lang.String zipCode)
                throws AddressException

Deprecated.

Sets the address zip code.

Parameters:

zipCode - The address zip code

Throws:

AddressException - if persisting fails.

getState

public java.lang.String getState()

Deprecated.

Returns the address state.

Returns:

the address state

setState

public void setState(java.lang.String state)
              throws AddressException

Deprecated.

Sets the address state.

Parameters:

state - The address state

Throws:

AddressException - if persisting fails.

getCountry

public java.lang.String getCountry()

Deprecated.

Returns the address country.

Returns:

the address country

setCountry

public void setCountry(java.lang.String country)
                throws AddressException

Deprecated.

Sets the address country.

Parameters:

country - The address country

Throws:

AddressException - if persisting fails.

compareTo

public int compareTo(Address address)

Deprecated.

Compares the current address with another one for sorting. The comparison is based on the last name if available, on the address path otherwise.

Specified by:

compareTo in interface java.lang.Comparable<Address>

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(java.lang.Class<AdapterType> type)

Deprecated.

Calls into the registered AdapterManager to adapt this object to the desired type.

This method implements a cache of adapters to improve performance. That is repeated calls to this method with the same class will result in the same object to be returned.

Specified by:

adaptTo in interface Adaptable

Overrides:

adaptTo in class SlingAdaptable

Type Parameters:

AdapterType - The generic type to which this resource is adapted to

Parameters:

type - The Class object of the target type, such as javax.jcr.Node.class or java.io.File.class

Returns:

The adapter target or null if the resource cannot adapt to the requested type