ezvcard.property

Class Deathdate

java.lang.Object

ezvcard.property.VCardProperty

ezvcard.property.DateOrTimeProperty

ezvcard.property.Deathdate

All Implemented Interfaces:

HasAltId, Comparable<VCardProperty>

@SupportedVersions(value=V4_0)
public class Deathdate
extends DateOrTimeProperty

Defines the person's time of death.

Code sample (creating)

 VCard vcard = new VCard();
 
 //date
 LocalDate date = LocalDate.of(1954, 6, 7);
 Deathdate deathdate = new Deathdate(date);
 vcard.setDeathdate(deathdate);
 
 //partial date (e.g. just the month and date)
 deathdate = new Deathdate(PartialDate.date(null, 6, 7)); //June 7
 vcard.setDeathdate(deathdate);
 
 //plain text value
 deathdate = new Deathdate("In the 1950s");
 vcard.setDeathdate(deathdate);
 

Code sample (retrieving)

 VCard vcard = ...
 Deathdate deathdate = vcard.getDeathdate();
 
 Temporal date = deathdate.getDate();
 if (date != null) {
   //property value is a date
 }
 
 PartialDate partialDate = deathdate.getPartialDate();
 if (partialDate != null) {
   //property value is a partial date
   int year = partialDate.getYear();
   int month = partialDate.getMonth();
 }
 
 String text = deathdate.getText();
 if (text != null) {
   //property value is plain text
 }
 

Property name: DEATHDATE

Supported versions: 4.0

Author:

Michael Angstadt

See Also:

RFC 6474 p.4

Field Summary

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Constructors

Constructor and Description
Deathdate(Deathdate original) Copy constructor.
Deathdate(PartialDate partialDate) Creates a deathdate property.
Deathdate(String text) Creates a deathdate property.
Deathdate(Temporal date) Creates a deathdate property.

Method Summary

Modifier and Type	Method and Description
Deathdate	copy() Creates a copy of this property object.

Methods inherited from class ezvcard.property.DateOrTimeProperty

_validate, equals, getAltId, getCalscale, getDate, getLanguage, getPartialDate, getText, hashCode, setAltId, setCalscale, setDate, setLanguage, setPartialDate, setText, toStringValues

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

Deathdate

public Deathdate(Temporal date)

Creates a deathdate property.

Parameters:

date - the deathdate

Deathdate

public Deathdate(PartialDate partialDate)

Creates a deathdate property.

Parameters:

partialDate - the deathdate (vCard 4.0 only)

Deathdate

public Deathdate(String text)

Creates a deathdate property.

Parameters:

text - the text value (vCard 4.0 only)

Deathdate

public Deathdate(Deathdate original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

copy

public Deathdate 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