Class DtStamp

All Implemented Interfaces:
Serializable, Comparable<Property>, FluentProperty

public class DtStamp extends UtcProperty
$Id$

Created: [Apr 6, 2004]

Defines a DTSTAMP iCalendar component property.

     4.8.7.2 Date/Time Stamp

        Property Name: DTSTAMP

        Purpose: The property indicates the date/time that the instance of
        the iCalendar object was created.

        Value Type: DATE-TIME

        Property Parameters: Non-standard property parameters can be
        specified on this property.

        Conformance: This property MUST be included in the "VEVENT", "VTODO",
        "VJOURNAL" or "VFREEBUSY" calendar components.

        Description: The value MUST be specified in the UTC time format.

        This property is also useful to protocols such as [IMIP] that have
        inherent latency issues with the delivery of content. This property
        will assist in the proper sequencing of messages containing iCalendar
        objects.

        This property is different than the "CREATED" and "LAST-MODIFIED"
        properties. These two properties are used to specify when the
        particular calendar data in the calendar store was created and last
        modified. This is different than when the iCalendar object
        representation of the calendar service information was created or
        last modified.

        Format Definition: The property is defined by the following notation:

          dtstamp    = "DTSTAMP" stmparam ":" date-time CRLF

          stmparam   = *(";" xparam)
 
See Also:
  • Constructor Details

    • DtStamp

      public DtStamp()
      Default constructor. Initialises the dateTime value to the time of instantiation.
    • DtStamp

      public DtStamp(String aValue) throws ParseException
      Parameters:
      aValue - a string representation of a DTSTAMP value
      Throws:
      ParseException - if the specified value is not a valid representation
    • DtStamp

      public DtStamp(ParameterList aList, String aValue) throws ParseException
      Parameters:
      aList - a list of parameters for this component
      aValue - a value string for this component
      Throws:
      ParseException - where the specified value string is not a valid date-time/date representation
    • DtStamp

      public DtStamp(DateTime aDate)
      Parameters:
      aDate - a date representing a date-time
    • DtStamp

      public DtStamp(ParameterList aList, DateTime aDate)
      Parameters:
      aList - a list of parameters for this component
      aDate - a date representing a date-time