ezvcard.property
Class Deathplace

java.lang.Object
  ezvcard.property.VCardProperty
      ezvcard.property.Deathplace

All Implemented Interfaces:

HasAltId, Comparable<VCardProperty>

public class Deathplace
extends VCardProperty
implements HasAltId

Defines the location of the person's death.

Code sample

 VCard vcard = new VCard();
 
 //URI (geo)
 Deathplace deathplace = new Deathplace();
 deathplace.setUri("geo:46.176502,-122.191658");
 vcard.setDeathplace(deathplace);
 
 //text
 deathplace = new Deathplace();
 deathplace.setText("Mount St. Helens");
 vcard.setDeathplace(deathplace);
 

Property name: DEATHPLACE

Supported versions: 4.0

Author:

Michael Angstadt

See Also:

RFC 6474

Field Summary

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Deathplace()

Method Summary

Set<VCardVersion>	_supportedVersions() Gets the vCard versions that support this property.
protected void	_validate(List<Warning> warnings, VCardVersion version, VCard vcard) Checks the property for data consistency problems or deviations from the spec.
String	getAltId() Gets the property's ALTID parameter.
String	getLanguage() Gets the language that the property value is written in.
String	getText() Gets the text value.
String	getUri() Gets the URI value.
void	setAltId(String altId) Sets the property's ALTID parameter.
void	setLanguage(String language) Sets the language that the property value is written in.
void	setText(String text) Sets the value to free-form text.
void	setUri(String uri) Sets the value to a URI.

Methods inherited from class ezvcard.property.VCardProperty

addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, removeParameter, setGroup, setParameter, setParameters, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Deathplace

public Deathplace()

Method Detail

_supportedVersions

public Set<VCardVersion> _supportedVersions()

Description copied from class: VCardProperty

Gets the vCard versions that support this property.

This method should be overridden by child classes if the property does not support all vCard versions. The default implementation of this method returns all vCard versions.

Overrides:

_supportedVersions in class VCardProperty

Returns:

the vCard versions that support this property.

getUri

public String getUri()

Gets the URI value.

Returns:

the URI value or null if no URI value is set

setUri

public void setUri(String uri)

Sets the value to a URI.

Parameters:

uri - the URI

getText

public String getText()

Gets the text value.

Returns:

the text value or null if no text value is set

setText

public void setText(String text)

Sets the value to free-form text.

Parameters:

text - the text

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)

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

See Also:

VCardParameters.getLanguage()

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

See Also:

VCardParameters.setLanguage(java.lang.String)

_validate

protected void _validate(List<Warning> 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