Address (ez-vcard 0.12.1 API)

java.lang.Object
- ezvcard.property.VCardProperty
- - ezvcard.property.Address

All Implemented Interfaces:: HasAltId, Comparable<VCardProperty>

public class Address
extends VCardProperty
implements HasAltId

Defines a mailing address.

Code sample (creating)

 VCard vcard = new VCard();
 
 Address adr = new Address();
 adr.setStreetAddress("123 Main St.");
 adr.setLocality("Austin");
 adr.setRegion("TX");
 adr.setPostalCode("12345");
 adr.setCountry("USA");
 adr.getTypes().add(AddressType.WORK);
 
 //optionally, set the text to print on the mailing label
 adr.setLabel("123 Main St.\nAustin, TX 12345\nUSA");
 
 vcard.addAddress(adr);

Code sample (retrieving)

 VCard vcard = ...
 for (Address adr : vcard.getAddresses()) {
   String street = adr.getStreetAddress();
   String city = adr.getLocality();
   //etc.
 }

Only part of the street address is being returned!

This usually means that the vCard you parsed contains unescaped comma characters. To get the full address, use the getStreetAddressFull() method.

Property name: ADR

Supported versions: 2.1, 3.0, 4.0

Author:: Michael Angstadt
See Also:: RFC 6350 p.32, RFC 2426 p.11, vCard 2.1 p.11

Field Summary
- Fields inherited from class ezvcard.property.VCardProperty
  group, parameters

Constructor Summary

Constructors
Constructor and Description

Address()

Address(Address original)
Copy constructor.

Constructors
Constructor and Description
`Address()`
`Address(Address original)` Copy constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_validate(List<ValidationWarning> warnings, VCardVersion version, VCard vcard)` Checks the property for data consistency problems or deviations from the spec.
`Address`	`copy()` Creates a copy of this property object.
`boolean`	`equals(Object obj)`
`String`	`getAltId()` Gets the property's ALTID parameter.
`List<String>`	`getCountries()` Gets the list that holds the countries that are assigned to this address.
`String`	`getCountry()` Gets the country.
`String`	`getExtendedAddress()` Gets the extended address.
`List<String>`	`getExtendedAddresses()` Gets the list that holds the extended addresses that are assigned to this address.
`String`	`getExtendedAddressFull()` Gets the extended address.
`GeoUri`	`getGeo()` Gets the global positioning coordinates that are associated with this address.
`String`	`getLabel()` Gets the label of the address.
`String`	`getLanguage()` Gets the language that the property value is written in.
`List<String>`	`getLocalities()` Gets the list that holds the localities that are assigned to this address.
`String`	`getLocality()` Gets the locality (city)
`List<Pid>`	`getPids()` Gets the list that stores this property's PID (property ID) parameter values.
`String`	`getPoBox()` Gets the P.O.
`List<String>`	`getPoBoxes()` Gets the list that holds the P.O.
`String`	`getPostalCode()` Gets the postal code (zip code).
`List<String>`	`getPostalCodes()` Gets the list that holds the postal codes that are assigned to this address.
`Integer`	`getPref()` Gets this property's preference value.
`String`	`getRegion()` Gets the region (state).
`List<String>`	`getRegions()` Gets the list that holds the regions that are assigned to this address.
`String`	`getStreetAddress()` Gets the street address
`List<String>`	`getStreetAddresses()` Gets the list that holds the street addresses that are assigned to this address.
`String`	`getStreetAddressFull()` Gets the street address.
`String`	`getTimezone()` Gets the timezone that's associated with this address.
`List<AddressType>`	`getTypes()` Gets the list that stores this property's address types (TYPE parameters).
`int`	`hashCode()`
`void`	`setAltId(String altId)` Sets the property's ALTID parameter.
`void`	`setCountry(String country)` Sets the country.
`void`	`setExtendedAddress(String extendedAddress)` Sets the extended address.
`void`	`setGeo(GeoUri uri)` Sets the global positioning coordinates that are associated with this address.
`void`	`setLabel(String label)` Sets the label of the address.
`void`	`setLanguage(String language)` Sets the language that the property value is written in.
`void`	`setLocality(String locality)` Sets the locality (city).
`void`	`setPoBox(String poBox)` Sets the P.O.
`void`	`setPostalCode(String postalCode)` Sets the postal code (zip code).
`void`	`setPref(Integer pref)` Sets this property's preference value.
`void`	`setRegion(String region)` Sets the region (state).
`void`	`setStreetAddress(String streetAddress)` Sets the street address.
`void`	`setTimezone(String timezone)` Sets the timezone that's associated with this address.
`protected Map<String,Object>`	`toStringValues()` Gets string representations of the class's fields for the `VCardProperty.toString()` method.

Methods inherited from class ezvcard.property.VCardProperty
addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, isSupportedBy, removeParameter, setGroup, setParameter, setParameters, toString, validate

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

- Constructor Detail
  - Address
```
public Address()
```
  - Address
```
public Address(Address original)
```
    Copy constructor.
    
    Parameters:
    
    original - the property to make a copy of
- Method Detail
  - getPoBox
```
public String getPoBox()
```
    Gets the P.O. (post office) box.
    
    Returns:
    
    the P.O. box or null if not set
  - getPoBoxes
```
public List<String> getPoBoxes()
```
    Gets the list that holds the P.O. (post office) boxes that are assigned to this address. An address is unlikely to have more than one, but it's possible nonetheless.
    
    Returns:
    
    the P.O. boxes (this list is mutable)
  - setPoBox
```
public void setPoBox(String poBox)
```
    Sets the P.O. (post office) box.
    
    Parameters:
    
    poBox - the P.O. box or null to remove
  - getExtendedAddress
```
public String getExtendedAddress()
```
    Gets the extended address.
    
    Returns:
    
    the extended address (e.g. "Suite 200") or null if not set
  - getExtendedAddresses
```
public List<String> getExtendedAddresses()
```
    Gets the list that holds the extended addresses that are assigned to this address. An address is unlikely to have more than one, but it's possible nonetheless.
    
    Returns:
    
    the extended addresses (this list is mutable)
  - getExtendedAddressFull
```
public String getExtendedAddressFull()
```
    Gets the extended address. Use this method when the ADR property of the vCard you are parsing contains unescaped comma characters.
    
    Returns:
    
    the extended address or null if not set
  - setExtendedAddress
```
public void setExtendedAddress(String extendedAddress)
```
    Sets the extended address.
    
    Parameters:
    
    extendedAddress - the extended address (e.g. "Suite 200") or null to remove
  - getStreetAddress
```
public String getStreetAddress()
```
    Gets the street address
    
    Returns:
    
    the street address (e.g. "123 Main St")
  - getStreetAddresses
```
public List<String> getStreetAddresses()
```
    Gets the list that holds the street addresses that are assigned to this address. An address is unlikely to have more than one, but it's possible nonetheless.
    
    Returns:
    
    the street addresses (this list is mutable)
  - getStreetAddressFull
```
public String getStreetAddressFull()
```
    Gets the street address. Use this method when the ADR property of the vCard you are parsing contains unescaped comma characters.
    
    Returns:
    
    the street address or null if not set
  - setStreetAddress
```
public void setStreetAddress(String streetAddress)
```
    Sets the street address.
    
    Parameters:
    
    streetAddress - the street address (e.g. "123 Main St") or null to remove
  - getLocality
```
public String getLocality()
```
    Gets the locality (city)
    
    Returns:
    
    the locality (e.g. "Boston") or null if not set
  - getLocalities
```
public List<String> getLocalities()
```
    Gets the list that holds the localities that are assigned to this address. An address is unlikely to have more than one, but it's possible nonetheless.
    
    Returns:
    
    the localities (this list is mutable)
  - setLocality
```
public void setLocality(String locality)
```
    Sets the locality (city).
    
    Parameters:
    
    locality - the locality or null to remove
  - getRegion
```
public String getRegion()
```
    Gets the region (state).
    
    Returns:
    
    the region (e.g. "Texas") or null if not set
  - getRegions
```
public List<String> getRegions()
```
    Gets the list that holds the regions that are assigned to this address. An address is unlikely to have more than one, but it's possible nonetheless.
    
    Returns:
    
    the regions (this list is mutable)
  - setRegion
```
public void setRegion(String region)
```
    Sets the region (state).
    
    Parameters:
    
    region - the region (e.g. "Texas") or null to remove
  - getPostalCode
```
public String getPostalCode()
```
    Gets the postal code (zip code).
    
    Returns:
    
    the postal code (e.g. "90210") or null if not set
  - getPostalCodes
```
public List<String> getPostalCodes()
```
    Gets the list that holds the postal codes that are assigned to this address. An address is unlikely to have more than one, but it's possible nonetheless.
    
    Returns:
    
    the postal codes (this list is mutable)
  - setPostalCode
```
public void setPostalCode(String postalCode)
```
    Sets the postal code (zip code).
    
    Parameters:
    
    postalCode - the postal code (e.g. "90210") or null to remove
  - getCountry
```
public String getCountry()
```
    Gets the country.
    
    Returns:
    
    the country (e.g. "USA") or null if not set
  - getCountries
```
public List<String> getCountries()
```
    Gets the list that holds the countries that are assigned to this address. An address is unlikely to have more than one, but it's possible nonetheless.
    
    Returns:
    
    the countries (this list is mutable)
  - setCountry
```
public void setCountry(String country)
```
    Sets the country.
    
    Parameters:
    
    country - the country (e.g. "USA") or null to remove
  - getTypes
```
public List<AddressType> getTypes()
```
    Gets the list that stores this property's address types (TYPE parameters).
    
    Returns:
    
    the address types (e.g. "HOME", "WORK") (this list is mutable)
  - getLanguage
```
public String getLanguage()
```
    Description copied from class: VCardProperty
    
    Gets the language that the property value is written in.
    
    Returns:
    
    the language or null if not set
  - setLanguage
```
public void setLanguage(String language)
```
    Description copied from class: VCardProperty
    
    Sets the language that the property value is written in.
    
    Parameters:
    
    language - the language or null to remove
  - getLabel
```
public String getLabel()
```
    Gets the label of the address.
    
    Returns:
    
    the label or null if not set
  - setLabel
```
public void setLabel(String label)
```
    Sets the label of the address.
    
    Parameters:
    
    label - the label or null to remove
  - getGeo
```
public GeoUri getGeo()
```
    Gets the global positioning coordinates that are associated with this address.
    
    Supported versions: 4.0
    
    Returns:
    
    the geo URI or not if not found
    
    See Also:
    
    VCardParameters.getGeo()
  - setGeo
```
public void setGeo(GeoUri uri)
```
    Sets the global positioning coordinates that are associated with this address.
    
    Supported versions: 4.0
    
    Parameters:
    
    uri - the geo URI or null to remove
    
    See Also:
    
    VCardParameters.setGeo(ezvcard.util.GeoUri)
  - getPids
```
public List<Pid> getPids()
```
    Description copied from class: VCardProperty
    
    Gets the list that stores this property's PID (property ID) parameter values.
    
    PIDs can exist on any property where multiple instances are allowed (such as Email or Address, but not StructuredName because only 1 instance of this property is allowed per vCard).
    
    When used in conjunction with the ClientPidMap property, it allows an individual property instance to be uniquely identifiable. This feature is made use of when two different versions of the same vCard have to be merged together (called "synchronizing").
    
    Supported versions: 4.0
    
    Returns:
    
    the PID parameter values (this list is mutable)
    
    See Also:
    
    RFC 6350 p.19
  - getPref
```
public Integer getPref()
```
    Description copied from class: VCardProperty
    Gets this property's preference value. The lower this number is, the more "preferred" the property instance is compared with other properties of the same type. If a property doesn't have a preference value, then it is considered the least preferred.
    
    In the vCard below, the Address on the second row is the most preferred because it has the lowest PREF value.
```
 ADR;TYPE=work;PREF=2:;;1600 Amphitheatre Parkway;Mountain View;CA;94043
 ADR;TYPE=work;PREF=1:;;One Microsoft Way;Redmond;WA;98052
 ADR;TYPE=home:;;123 Maple St;Hometown;KS;12345
 
```
    Supported versions: 4.0
    Returns:
    
    the preference value or null if not set
    
    See Also:
    
    RFC 6350 p.17
  - setPref
```
public void setPref(Integer pref)
```
    Description copied from class: VCardProperty
    Sets this property's preference value. The lower this number is, the more "preferred" the property instance is compared with other properties of the same type. If a property doesn't have a preference value, then it is considered the least preferred.
    
    In the vCard below, the Address on the second row is the most preferred because it has the lowest PREF value.
```
 ADR;TYPE=work;PREF=2:;;1600 Amphitheatre Parkway;Mountain View;CA;94043
 ADR;TYPE=work;PREF=1:;;One Microsoft Way;Redmond;WA;98052
 ADR;TYPE=home:;;123 Maple St;Hometown;KS;12345
 
```
    Supported versions: 4.0
    Parameters:
    
    pref - the preference value or null to remove
    
    See Also:
    
    RFC 6350 p.17
  - getAltId
```
public String getAltId()
```
    Description copied from interface: HasAltId
    
    Gets the property's ALTID parameter.
    Supported versions: 4.0
    
    Specified by:
    
    getAltId in interface HasAltId
    
    Returns:
    
    the ALTID or null if it doesn't exist
    
    See Also:
    
    VCardParameters.getAltId()
  - setAltId
```
public void setAltId(String altId)
```
    Description copied from interface: HasAltId
    
    Sets the property's ALTID parameter.
    Supported versions: 4.0
    
    Specified by:
    
    setAltId in interface HasAltId
    
    Parameters:
    
    altId - the ALTID or null to remove
    
    See Also:
    
    VCardParameters.setAltId(java.lang.String)
  - getTimezone
```
public String getTimezone()
```
    Gets the timezone that's associated with this address.
    Supported versions: 4.0
    
    Returns:
    
    the timezone (e.g. "America/New_York") or null if not set
  - setTimezone
```
public void setTimezone(String timezone)
```
    Sets the timezone that's associated with this address.
    Supported versions: 4.0
    
    Parameters:
    
    timezone - the timezone (e.g. "America/New_York") or null to remove
  - _validate
```
protected void _validate(List<ValidationWarning> warnings,
                         VCardVersion version,
                         VCard vcard)
```
    Description copied from class: VCardProperty
    
    Checks the property for data consistency problems or deviations from the spec. Meant to be overridden by child classes that wish to provide validation logic.
    
    Overrides:
    
    _validate in class VCardProperty
    
    Parameters:
    
    warnings - the list to add the warnings to
    
    version - the version to check the property against
    
    vcard - the vCard this property belongs to
  - toStringValues
```
protected Map<String,Object> toStringValues()
```
    Description copied from class: VCardProperty
    
    Gets string representations of the class's fields for the VCardProperty.toString() method.
    
    Meant to be overridden by child classes. The default implementation returns an empty map.
    
    Overrides:
    
    toStringValues in class VCardProperty
    
    Returns:
    
    the values of the class's fields (key = field name, value = field value)
  - copy
```
public Address copy()
```
    Description copied from class: VCardProperty
    
    Creates a copy of this property object.
    
    The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.
    
    The child class's copy constructor, if present, MUST invoke the VCardProperty.VCardProperty(VCardProperty) super constructor to ensure that the group name and parameters are also copied.
    
    This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the property (such as in the VCard class's copy constructor).
    
    Overrides:
    
    copy in class VCardProperty
    
    Returns:
    
    the copy
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class VCardProperty
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class VCardProperty

Class Address

Field Summary

Fields inherited from class ezvcard.property.VCardProperty

Constructor Summary

Method Summary

Methods inherited from class ezvcard.property.VCardProperty

Methods inherited from class java.lang.Object

Constructor Detail

Address

Address

Method Detail

getPoBox

getPoBoxes

setPoBox

getExtendedAddress

getExtendedAddresses

getExtendedAddressFull

setExtendedAddress

getStreetAddress

getStreetAddresses

getStreetAddressFull

setStreetAddress

getLocality

getLocalities

setLocality

getRegion

getRegions

setRegion

getPostalCode

getPostalCodes

setPostalCode

getCountry

getCountries

setCountry

getTypes

getLanguage

setLanguage

getLabel

setLabel

getGeo

setGeo

getPids

getPref

setPref

getAltId

setAltId

getTimezone

setTimezone

_validate

toStringValues

copy

hashCode

equals