ezvcard.property

Class DateOrTimeProperty

java.lang.Object

ezvcard.property.VCardProperty

ezvcard.property.DateOrTimeProperty

All Implemented Interfaces:

HasAltId, Comparable<VCardProperty>

Direct Known Subclasses:

Anniversary, Birthday, Deathdate

public class DateOrTimeProperty
extends VCardProperty
implements HasAltId

Represents a property that typically contains a date/time value, but can also contain a partial date or free-text value.

Author:

Michael Angstadt

Field Summary

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Constructors

Constructor and Description
DateOrTimeProperty(DateOrTimeProperty original) Copy constructor.
DateOrTimeProperty(PartialDate partialDate) Creates a date-and-or-time property.
DateOrTimeProperty(String text) Creates a date-and-or-time property.
DateOrTimeProperty(Temporal date) Creates a date-and-or-time property.

Method Summary

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.
boolean	equals(Object obj)
String	getAltId() Gets the property's ALTID parameter.
Calscale	getCalscale() Gets the type of calendar that is used for a date or date-time property value.
Temporal	getDate() Gets the date value.
String	getLanguage() Gets the language that the property value is written in.
PartialDate	getPartialDate() Gets the reduced accuracy or truncated date.
String	getText() Gets the text value of this type.
int	hashCode()
void	setAltId(String altId) Sets the property's ALTID parameter.
void	setCalscale(Calscale calscale) Sets the type of calendar that is used for a date or date-time property value.
void	setDate(Temporal date) Sets the value of this property to a date.
void	setLanguage(String language) Sets the language that the property value is written in.
void	setPartialDate(PartialDate partialDate) Sets the value of this property to a reduced accuracy or truncated date.
void	setText(String text) Sets the value of this property to a text string.
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, copy, 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

DateOrTimeProperty

public DateOrTimeProperty(Temporal date)

Creates a date-and-or-time property.

Parameters:

date - the date value (should be one of the following: LocalDate, LocalDateTime, OffsetDateTime, Instant)

DateOrTimeProperty

public DateOrTimeProperty(PartialDate partialDate)

Creates a date-and-or-time property.

Parameters:

partialDate - the partial date value (vCard 4.0 only)

DateOrTimeProperty

public DateOrTimeProperty(String text)

Creates a date-and-or-time property.

Parameters:

text - the text value (vCard 4.0 only)

DateOrTimeProperty

public DateOrTimeProperty(DateOrTimeProperty original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

getDate

public Temporal getDate()

Gets the date value. It should be an instance of one of the following classes: LocalDate, LocalDateTime, OffsetDateTime, Instant.

Returns:

the date value or null if not set

setDate

public void setDate(Temporal date)

Sets the value of this property to a date. It should be an instance of one of the following classes: LocalDate, LocalDateTime, OffsetDateTime, Instant.

Parameters:

date - the date

getPartialDate

public PartialDate getPartialDate()

Gets the reduced accuracy or truncated date. This is only supported by vCard 4.0.

Returns:

the reduced accuracy or truncated date or null if not set

See Also:

RFC 6350 p.12-14

setPartialDate

public void setPartialDate(PartialDate partialDate)

Sets the value of this property to a reduced accuracy or truncated date. This is only supported by vCard 4.0.

 Birthday bday = new Birthday();
 bday.setPartialDate(PartialDate.date(null, 4, 20)); //April 20
 

Parameters:

partialDate - the reduced accuracy or truncated date

See Also:

RFC 6350 p.12-14

getText

public String getText()

Gets the text value of this type. This is only supported by vCard 4.0.

Returns:

the text value or null if not set

setText

public void setText(String text)

Sets the value of this property to a text string. This is only supported by vCard 4.0.

Parameters:

text - the text value or null if not set

getCalscale

public Calscale getCalscale()

Gets the type of calendar that is used for a date or date-time property value.

Supported versions: 4.0

Returns:

the type of calendar or null if not found

See Also:

VCardParameters.getCalscale()

setCalscale

public void setCalscale(Calscale calscale)

Sets the type of calendar that is used for a date or date-time property value.

Supported versions: 4.0

Parameters:

calscale - the type of calendar or null to remove

See Also:

VCardParameters.setCalscale(ezvcard.parameter.Calscale)

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

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)

_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)

hashCode

public int hashCode()

Overrides:

hashCode in class VCardProperty

equals

public boolean equals(Object obj)

Overrides:

equals in class VCardProperty