michael@0: /**
michael@0:  * Copyright (c) 2012, Ben Fortuna
michael@0:  * All rights reserved.
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  *
michael@0:  *  o Redistributions of source code must retain the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer.
michael@0:  *
michael@0:  *  o Redistributions in binary form must reproduce the above copyright
michael@0:  * notice, this list of conditions and the following disclaimer in the
michael@0:  * documentation and/or other materials provided with the distribution.
michael@0:  *
michael@0:  *  o Neither the name of Ben Fortuna nor the names of any other contributors
michael@0:  * may be used to endorse or promote products derived from this software
michael@0:  * without specific prior written permission.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
michael@0:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
michael@0:  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
michael@0:  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
michael@0:  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
michael@0:  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
michael@0:  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
michael@0:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: package net.fortuna.ical4j.model.property;
michael@0: 
michael@0: import java.text.ParseException;
michael@0: 
michael@0: import net.fortuna.ical4j.model.DateTime;
michael@0: import net.fortuna.ical4j.model.ParameterList;
michael@0: import net.fortuna.ical4j.model.PropertyFactoryImpl;
michael@0: 
michael@0: /**
michael@0:  * $Id$
michael@0:  * 
michael@0:  * Created: [Apr 6, 2004]
michael@0:  *
michael@0:  * Defines a DTSTAMP iCalendar component property.
michael@0:  * 
michael@0:  * <pre>
michael@0:  *     4.8.7.2 Date/Time Stamp
michael@0:  *     
michael@0:  *        Property Name: DTSTAMP
michael@0:  *     
michael@0:  *        Purpose: The property indicates the date/time that the instance of
michael@0:  *        the iCalendar object was created.
michael@0:  *     
michael@0:  *        Value Type: DATE-TIME
michael@0:  *     
michael@0:  *        Property Parameters: Non-standard property parameters can be
michael@0:  *        specified on this property.
michael@0:  *     
michael@0:  *        Conformance: This property MUST be included in the &quot;VEVENT&quot;, &quot;VTODO&quot;,
michael@0:  *        &quot;VJOURNAL&quot; or &quot;VFREEBUSY&quot; calendar components.
michael@0:  *     
michael@0:  *        Description: The value MUST be specified in the UTC time format.
michael@0:  *     
michael@0:  *        This property is also useful to protocols such as [IMIP] that have
michael@0:  *        inherent latency issues with the delivery of content. This property
michael@0:  *        will assist in the proper sequencing of messages containing iCalendar
michael@0:  *        objects.
michael@0:  *     
michael@0:  *        This property is different than the &quot;CREATED&quot; and &quot;LAST-MODIFIED&quot;
michael@0:  *        properties. These two properties are used to specify when the
michael@0:  *        particular calendar data in the calendar store was created and last
michael@0:  *        modified. This is different than when the iCalendar object
michael@0:  *        representation of the calendar service information was created or
michael@0:  *        last modified.
michael@0:  *     
michael@0:  *        Format Definition: The property is defined by the following notation:
michael@0:  *     
michael@0:  *          dtstamp    = &quot;DTSTAMP&quot; stmparam &quot;:&quot; date-time CRLF
michael@0:  *     
michael@0:  *          stmparam   = *(&quot;;&quot; xparam)
michael@0:  * </pre>
michael@0:  * 
michael@0:  * @author Ben Fortuna
michael@0:  */
michael@0: public class DtStamp extends UtcProperty {
michael@0: 
michael@0:     private static final long serialVersionUID = 7581197869433744070L;
michael@0: 
michael@0:     /**
michael@0:      * Default constructor. Initialises the dateTime value to the time of instantiation.
michael@0:      */
michael@0:     public DtStamp() {
michael@0:         super(DTSTAMP, PropertyFactoryImpl.getInstance());
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aValue a string representation of a DTSTAMP value
michael@0:      * @throws ParseException if the specified value is not a valid representation
michael@0:      */
michael@0:     public DtStamp(final String aValue) throws ParseException {
michael@0:     	this(new ParameterList(), aValue);
michael@0:     }
michael@0:     
michael@0:     /**
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param aValue a value string for this component
michael@0:      * @throws ParseException where the specified value string is not a valid date-time/date representation
michael@0:      */
michael@0:     public DtStamp(final ParameterList aList, final String aValue)
michael@0:             throws ParseException {
michael@0:         super(DTSTAMP, aList, PropertyFactoryImpl.getInstance());
michael@0:         setValue(aValue);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aDate a date representing a date-time 
michael@0:      */
michael@0:     public DtStamp(final DateTime aDate) {
michael@0:         super(DTSTAMP, PropertyFactoryImpl.getInstance());
michael@0:         // time must be in UTC..
michael@0:         aDate.setUtc(true);
michael@0:         setDate(aDate);
michael@0:     }
michael@0: 
michael@0:     /**
michael@0:      * @param aList a list of parameters for this component
michael@0:      * @param aDate a date representing a date-time
michael@0:      */
michael@0:     public DtStamp(final ParameterList aList, final DateTime aDate) {
michael@0:         super(DTSTAMP, aList, PropertyFactoryImpl.getInstance());
michael@0:         // time must be in UTC..
michael@0:         aDate.setUtc(true);
michael@0:         setDate(aDate);
michael@0:     }
michael@0: }