diff -r 000000000000 -r fb9019fb1bf7 src/net/fortuna/ical4j/model/property/DtStamp.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/net/fortuna/ical4j/model/property/DtStamp.java Tue Feb 10 18:12:00 2015 +0100 @@ -0,0 +1,136 @@ +/** + * Copyright (c) 2012, Ben Fortuna + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * o Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * o Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * o Neither the name of Ben Fortuna nor the names of any other contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +package net.fortuna.ical4j.model.property; + +import java.text.ParseException; + +import net.fortuna.ical4j.model.DateTime; +import net.fortuna.ical4j.model.ParameterList; +import net.fortuna.ical4j.model.PropertyFactoryImpl; + +/** + * $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)
+ * 
+ * + * @author Ben Fortuna + */ +public class DtStamp extends UtcProperty { + + private static final long serialVersionUID = 7581197869433744070L; + + /** + * Default constructor. Initialises the dateTime value to the time of instantiation. + */ + public DtStamp() { + super(DTSTAMP, PropertyFactoryImpl.getInstance()); + } + + /** + * @param aValue a string representation of a DTSTAMP value + * @throws ParseException if the specified value is not a valid representation + */ + public DtStamp(final String aValue) throws ParseException { + this(new ParameterList(), aValue); + } + + /** + * @param aList a list of parameters for this component + * @param aValue a value string for this component + * @throws ParseException where the specified value string is not a valid date-time/date representation + */ + public DtStamp(final ParameterList aList, final String aValue) + throws ParseException { + super(DTSTAMP, aList, PropertyFactoryImpl.getInstance()); + setValue(aValue); + } + + /** + * @param aDate a date representing a date-time + */ + public DtStamp(final DateTime aDate) { + super(DTSTAMP, PropertyFactoryImpl.getInstance()); + // time must be in UTC.. + aDate.setUtc(true); + setDate(aDate); + } + + /** + * @param aList a list of parameters for this component + * @param aDate a date representing a date-time + */ + public DtStamp(final ParameterList aList, final DateTime aDate) { + super(DTSTAMP, aList, PropertyFactoryImpl.getInstance()); + // time must be in UTC.. + aDate.setUtc(true); + setDate(aDate); + } +}