1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/net/fortuna/ical4j/model/property/DtStamp.java Tue Feb 10 18:12:00 2015 +0100
1.3 @@ -0,0 +1,136 @@
1.4 +/**
1.5 + * Copyright (c) 2012, Ben Fortuna
1.6 + * All rights reserved.
1.7 + *
1.8 + * Redistribution and use in source and binary forms, with or without
1.9 + * modification, are permitted provided that the following conditions
1.10 + * are met:
1.11 + *
1.12 + * o Redistributions of source code must retain the above copyright
1.13 + * notice, this list of conditions and the following disclaimer.
1.14 + *
1.15 + * o Redistributions in binary form must reproduce the above copyright
1.16 + * notice, this list of conditions and the following disclaimer in the
1.17 + * documentation and/or other materials provided with the distribution.
1.18 + *
1.19 + * o Neither the name of Ben Fortuna nor the names of any other contributors
1.20 + * may be used to endorse or promote products derived from this software
1.21 + * without specific prior written permission.
1.22 + *
1.23 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1.24 + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1.25 + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1.26 + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
1.27 + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
1.28 + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
1.29 + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
1.30 + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
1.31 + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
1.32 + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
1.33 + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.34 + */
1.35 +package net.fortuna.ical4j.model.property;
1.36 +
1.37 +import java.text.ParseException;
1.38 +
1.39 +import net.fortuna.ical4j.model.DateTime;
1.40 +import net.fortuna.ical4j.model.ParameterList;
1.41 +import net.fortuna.ical4j.model.PropertyFactoryImpl;
1.42 +
1.43 +/**
1.44 + * $Id$
1.45 + *
1.46 + * Created: [Apr 6, 2004]
1.47 + *
1.48 + * Defines a DTSTAMP iCalendar component property.
1.49 + *
1.50 + * <pre>
1.51 + * 4.8.7.2 Date/Time Stamp
1.52 + *
1.53 + * Property Name: DTSTAMP
1.54 + *
1.55 + * Purpose: The property indicates the date/time that the instance of
1.56 + * the iCalendar object was created.
1.57 + *
1.58 + * Value Type: DATE-TIME
1.59 + *
1.60 + * Property Parameters: Non-standard property parameters can be
1.61 + * specified on this property.
1.62 + *
1.63 + * Conformance: This property MUST be included in the "VEVENT", "VTODO",
1.64 + * "VJOURNAL" or "VFREEBUSY" calendar components.
1.65 + *
1.66 + * Description: The value MUST be specified in the UTC time format.
1.67 + *
1.68 + * This property is also useful to protocols such as [IMIP] that have
1.69 + * inherent latency issues with the delivery of content. This property
1.70 + * will assist in the proper sequencing of messages containing iCalendar
1.71 + * objects.
1.72 + *
1.73 + * This property is different than the "CREATED" and "LAST-MODIFIED"
1.74 + * properties. These two properties are used to specify when the
1.75 + * particular calendar data in the calendar store was created and last
1.76 + * modified. This is different than when the iCalendar object
1.77 + * representation of the calendar service information was created or
1.78 + * last modified.
1.79 + *
1.80 + * Format Definition: The property is defined by the following notation:
1.81 + *
1.82 + * dtstamp = "DTSTAMP" stmparam ":" date-time CRLF
1.83 + *
1.84 + * stmparam = *(";" xparam)
1.85 + * </pre>
1.86 + *
1.87 + * @author Ben Fortuna
1.88 + */
1.89 +public class DtStamp extends UtcProperty {
1.90 +
1.91 + private static final long serialVersionUID = 7581197869433744070L;
1.92 +
1.93 + /**
1.94 + * Default constructor. Initialises the dateTime value to the time of instantiation.
1.95 + */
1.96 + public DtStamp() {
1.97 + super(DTSTAMP, PropertyFactoryImpl.getInstance());
1.98 + }
1.99 +
1.100 + /**
1.101 + * @param aValue a string representation of a DTSTAMP value
1.102 + * @throws ParseException if the specified value is not a valid representation
1.103 + */
1.104 + public DtStamp(final String aValue) throws ParseException {
1.105 + this(new ParameterList(), aValue);
1.106 + }
1.107 +
1.108 + /**
1.109 + * @param aList a list of parameters for this component
1.110 + * @param aValue a value string for this component
1.111 + * @throws ParseException where the specified value string is not a valid date-time/date representation
1.112 + */
1.113 + public DtStamp(final ParameterList aList, final String aValue)
1.114 + throws ParseException {
1.115 + super(DTSTAMP, aList, PropertyFactoryImpl.getInstance());
1.116 + setValue(aValue);
1.117 + }
1.118 +
1.119 + /**
1.120 + * @param aDate a date representing a date-time
1.121 + */
1.122 + public DtStamp(final DateTime aDate) {
1.123 + super(DTSTAMP, PropertyFactoryImpl.getInstance());
1.124 + // time must be in UTC..
1.125 + aDate.setUtc(true);
1.126 + setDate(aDate);
1.127 + }
1.128 +
1.129 + /**
1.130 + * @param aList a list of parameters for this component
1.131 + * @param aDate a date representing a date-time
1.132 + */
1.133 + public DtStamp(final ParameterList aList, final DateTime aDate) {
1.134 + super(DTSTAMP, aList, PropertyFactoryImpl.getInstance());
1.135 + // time must be in UTC..
1.136 + aDate.setUtc(true);
1.137 + setDate(aDate);
1.138 + }
1.139 +}
