ezvcard.types
Class DateOrTimeType

java.lang.Object
  ezvcard.types.VCardType
      ezvcard.types.DateOrTimeType

All Implemented Interfaces:

Comparable<VCardType>

Direct Known Subclasses:

AnniversaryType, BirthdayType, DeathdateType

public class DateOrTimeType
extends VCardType

Represents a type that contains a date and/or time (for example, the BDAY type).

Author:

Michael Angstadt

Field Summary

Fields inherited from class ezvcard.types.VCardType

group, subTypes, typeName

Constructor Summary

DateOrTimeType(String typeName)

DateOrTimeType(String typeName, Date date)

Method Summary

protected void	doMarshalSubTypes(VCardSubTypes copy, VCardVersion version, List<String> warnings, CompatibilityMode compatibilityMode, VCard vcard) Gets the sub types that will be sent over the wire.
protected void	doMarshalText(StringBuilder sb, VCardVersion version, List<String> warnings, CompatibilityMode compatibilityMode) Converts this type object to a string for sending over the wire.
protected void	doMarshalXml(XCardElement parent, List<String> warnings, CompatibilityMode compatibilityMode) Marshals this type for inclusion in an xCard (XML document).
protected void	doUnmarshalHtml(HCardElement element, List<String> warnings) Unmarshals the type from an hCard (HTML document).
protected void	doUnmarshalText(String value, VCardVersion version, List<String> warnings, CompatibilityMode compatibilityMode) Unmarshals the type value from off the wire.
protected void	doUnmarshalXml(XCardElement element, List<String> warnings, CompatibilityMode compatibilityMode) Unmarshals the type from an xCard (XML document).
String	getAltId() Gets the ALTID.
CalscaleParameter	getCalscale() Gets the type of calendar this date uses.
Date	getDate() Gets the date value.
String	getReducedAccuracyDate() Gets the reduced accuracy date string.
String	getText() Gets the text value of this type.
void	setAltId(String altId) Sets the ALTID.
void	setCalsclae(CalscaleParameter calscale) Sets the type of calendar this date uses.
void	setDate(Date date, boolean dateHasTime) Sets the value of this type to a complete date.
void	setReducedAccuracyDate(String reducedAccuracyDate) Sets the value of this type to a "reduced accuracy" date.
void	setText(String text) Sets the value of this type to a text string.

Methods inherited from class ezvcard.types.VCardType

compareTo, getGroup, getQName, getSubTypes, getSupportedVersions, getTypeName, marshalSubTypes, marshalText, marshalXml, setGroup, unmarshalHtml, unmarshalText, unmarshalXml

Methods inherited from class java.lang.Object

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

Constructor Detail

DateOrTimeType

public DateOrTimeType(String typeName)

Parameters:

typeName - the name of the type (e.g. "BDAY")

DateOrTimeType

public DateOrTimeType(String typeName,
                      Date date)

Parameters:

typeName - the name of the type (e.g. "BDAY")

date - the date value

Method Detail

getDate

public Date getDate()

Gets the date value.

Returns:

the date value or null if not set

setDate

public void setDate(Date date,
                    boolean dateHasTime)

Sets the value of this type to a complete date.

Parameters:

date - the date

dateHasTime - true if the date contains a time component, false if it's just a date

getReducedAccuracyDate

public String getReducedAccuracyDate()

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

Returns:

the reduced accuracy date string or null if not set

See Also:

"RFC 6350 p.12-14 for examples"

setReducedAccuracyDate

public void setReducedAccuracyDate(String reducedAccuracyDate)

Sets the value of this type to a "reduced accuracy" date. This is only supported by vCard 4.0.

Parameters:

reducedAccuracyDate - the reduced accuracy date (e.g "--0210" for "February 10")

See Also:

"RFC 6350 p.12-14 for examples"

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 type to a text string. This is only supported by vCard 4.0.

Parameters:

text - the text value

getCalscale

public CalscaleParameter getCalscale()

Gets the type of calendar this date uses.

vCard versions: 4.0

Returns:

the type of calendar or null if not set

setCalsclae

public void setCalsclae(CalscaleParameter calscale)

Sets the type of calendar this date uses.

vCard versions: 4.0

Parameters:

calscale - the type of calendar or null to remove

getAltId

public String getAltId()

Gets the ALTID.

vCard versions: 4.0

Returns:

the ALTID or null if it doesn't exist

See Also:

VCardSubTypes.getAltId()

setAltId

public void setAltId(String altId)

Sets the ALTID.

vCard versions: 4.0

Parameters:

altId - the ALTID or null to remove

See Also:

VCardSubTypes.setAltId(java.lang.String)

doMarshalSubTypes

protected void doMarshalSubTypes(VCardSubTypes copy,
                                 VCardVersion version,
                                 List<String> warnings,
                                 CompatibilityMode compatibilityMode,
                                 VCard vcard)

Description copied from class: VCardType

Gets the sub types that will be sent over the wire.

If this method is NOT overridden, then the type's sub types will be sent over the wire as-is. In other words, whatever is in the VCardType.subTypes field will be sent. Child classes can override this method in order to modify the sub types before they are marshalled.

Overrides:

doMarshalSubTypes in class VCardType

Parameters:

copy - the sub types that will be marshalled into the vCard. This object is a copy of the VCardType.subTypes field, so any modifications done to this object will not effect the state of the field.

version - the version vCard that is being generated

warnings - allows the programmer to alert the user to any note-worthy (but non-critical) issues that occurred during the marshalling process

compatibilityMode - allows the programmer to customize the marshalling process depending on the expected consumer of the vCard

vcard - the VCard object that is being marshalled

doMarshalText

protected void doMarshalText(StringBuilder sb,
                             VCardVersion version,
                             List<String> warnings,
                             CompatibilityMode compatibilityMode)

Description copied from class: VCardType

Converts this type object to a string for sending over the wire. It is NOT responsible for folding.

Specified by:

doMarshalText in class VCardType

Parameters:

sb - the buffer to add the marshalled value to

version - the version vCard that is being generated

warnings - allows the programmer to alert the user to any note-worthy (but non-critical) issues that occurred during the marshalling process

compatibilityMode - allows the programmer to customize the marshalling process depending on the expected consumer of the vCard

doUnmarshalText

protected void doUnmarshalText(String value,
                               VCardVersion version,
                               List<String> warnings,
                               CompatibilityMode compatibilityMode)

Description copied from class: VCardType

Unmarshals the type value from off the wire.

Specified by:

doUnmarshalText in class VCardType

Parameters:

value - the unfolded value from off the wire. If the wire value is in the "quoted-printable" encoding, it will be decoded.

version - the version of the vCard that is being read or null if the VERSION type has not been parsed yet (v3.0 and v4.0 require that the VERSION type be at the top of the vCard, but v2.1 has no such requirement)

warnings - allows the programmer to alert the user to any note-worthy (but non-critical) issues that occurred during the unmarshalling process

compatibilityMode - allows you to customize the unmarshalling process depending on where the vCard came from

doMarshalXml

protected void doMarshalXml(XCardElement parent,
                            List<String> warnings,
                            CompatibilityMode compatibilityMode)

Description copied from class: VCardType

Marshals this type for inclusion in an xCard (XML document). All child classes SHOULD override this, but are not required to.

Overrides:

doMarshalXml in class VCardType

Parameters:

parent - the XML element that the type's value will be inserted into. For example, this would be the "<fn>" element for the "FN" type.

warnings - allows the programmer to alert the user to any note-worthy (but non-critical) issues that occurred during the marshalling process

compatibilityMode - allows the programmer to customize the marshalling process depending on the expected consumer of the vCard

doUnmarshalXml

protected void doUnmarshalXml(XCardElement element,
                              List<String> warnings,
                              CompatibilityMode compatibilityMode)

Description copied from class: VCardType

Unmarshals the type from an xCard (XML document).

Overrides:

doUnmarshalXml in class VCardType

Parameters:

element - the XML element that contains the type data. For example, this would be the "<fn>" element for the "FN" type. This object will NOT include the "<parameters>" child element (it is removed after being unmarshalled into a VCardSubTypes object).

warnings - allows the programmer to alert the user to any note-worthy (but non-critical) issues that occurred during the unmarshalling process

compatibilityMode - allows the programmer to customize the unmarshalling process depending on where the vCard came from

doUnmarshalHtml

protected void doUnmarshalHtml(HCardElement element,
                               List<String> warnings)

Description copied from class: VCardType

Unmarshals the type from an hCard (HTML document).

Overrides:

doUnmarshalHtml in class VCardType

Parameters:

element - the HTML element that contains the type data.

warnings - allows the programmer to alert the user to any note-worthy (but non-critical) issues that occurred during the unmarshalling process