src/net/fortuna/ical4j/model/property/DtStamp.java@fb9019fb1bf7 (annotated)
src/net/fortuna/ical4j/model/property/DtStamp.java
Tue, 10 Feb 2015 18:12:00 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Tue, 10 Feb 2015 18:12:00 +0100
- changeset 0
- fb9019fb1bf7
- permissions
- -rw-r--r--
Import initial revisions of existing project AndroidCaldavSyncAdapater,
forked from upstream repository at 27e8a0f8495c92e0780d450bdf0c7cec77a03a55.
| michael@0 | 1 | /** |
| michael@0 | 2 | * Copyright (c) 2012, Ben Fortuna |
| michael@0 | 3 | * All rights reserved. |
| michael@0 | 4 | * |
| michael@0 | 5 | * Redistribution and use in source and binary forms, with or without |
| michael@0 | 6 | * modification, are permitted provided that the following conditions |
| michael@0 | 7 | * are met: |
| michael@0 | 8 | * |
| michael@0 | 9 | * o Redistributions of source code must retain the above copyright |
| michael@0 | 10 | * notice, this list of conditions and the following disclaimer. |
| michael@0 | 11 | * |
| michael@0 | 12 | * o Redistributions in binary form must reproduce the above copyright |
| michael@0 | 13 | * notice, this list of conditions and the following disclaimer in the |
| michael@0 | 14 | * documentation and/or other materials provided with the distribution. |
| michael@0 | 15 | * |
| michael@0 | 16 | * o Neither the name of Ben Fortuna nor the names of any other contributors |
| michael@0 | 17 | * may be used to endorse or promote products derived from this software |
| michael@0 | 18 | * without specific prior written permission. |
| michael@0 | 19 | * |
| michael@0 | 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| michael@0 | 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| michael@0 | 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| michael@0 | 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
| michael@0 | 24 | * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| michael@0 | 25 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
| michael@0 | 26 | * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
| michael@0 | 27 | * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF |
| michael@0 | 28 | * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
| michael@0 | 29 | * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| michael@0 | 30 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| michael@0 | 31 | */ |
| michael@0 | 32 | package net.fortuna.ical4j.model.property; |
| michael@0 | 33 | |
| michael@0 | 34 | import java.text.ParseException; |
| michael@0 | 35 | |
| michael@0 | 36 | import net.fortuna.ical4j.model.DateTime; |
| michael@0 | 37 | import net.fortuna.ical4j.model.ParameterList; |
| michael@0 | 38 | import net.fortuna.ical4j.model.PropertyFactoryImpl; |
| michael@0 | 39 | |
| michael@0 | 40 | /** |
| michael@0 | 41 | * $Id$ |
| michael@0 | 42 | * |
| michael@0 | 43 | * Created: [Apr 6, 2004] |
| michael@0 | 44 | * |
| michael@0 | 45 | * Defines a DTSTAMP iCalendar component property. |
| michael@0 | 46 | * |
| michael@0 | 47 | * <pre> |
| michael@0 | 48 | * 4.8.7.2 Date/Time Stamp |
| michael@0 | 49 | * |
| michael@0 | 50 | * Property Name: DTSTAMP |
| michael@0 | 51 | * |
| michael@0 | 52 | * Purpose: The property indicates the date/time that the instance of |
| michael@0 | 53 | * the iCalendar object was created. |
| michael@0 | 54 | * |
| michael@0 | 55 | * Value Type: DATE-TIME |
| michael@0 | 56 | * |
| michael@0 | 57 | * Property Parameters: Non-standard property parameters can be |
| michael@0 | 58 | * specified on this property. |
| michael@0 | 59 | * |
| michael@0 | 60 | * Conformance: This property MUST be included in the "VEVENT", "VTODO", |
| michael@0 | 61 | * "VJOURNAL" or "VFREEBUSY" calendar components. |
| michael@0 | 62 | * |
| michael@0 | 63 | * Description: The value MUST be specified in the UTC time format. |
| michael@0 | 64 | * |
| michael@0 | 65 | * This property is also useful to protocols such as [IMIP] that have |
| michael@0 | 66 | * inherent latency issues with the delivery of content. This property |
| michael@0 | 67 | * will assist in the proper sequencing of messages containing iCalendar |
| michael@0 | 68 | * objects. |
| michael@0 | 69 | * |
| michael@0 | 70 | * This property is different than the "CREATED" and "LAST-MODIFIED" |
| michael@0 | 71 | * properties. These two properties are used to specify when the |
| michael@0 | 72 | * particular calendar data in the calendar store was created and last |
| michael@0 | 73 | * modified. This is different than when the iCalendar object |
| michael@0 | 74 | * representation of the calendar service information was created or |
| michael@0 | 75 | * last modified. |
| michael@0 | 76 | * |
| michael@0 | 77 | * Format Definition: The property is defined by the following notation: |
| michael@0 | 78 | * |
| michael@0 | 79 | * dtstamp = "DTSTAMP" stmparam ":" date-time CRLF |
| michael@0 | 80 | * |
| michael@0 | 81 | * stmparam = *(";" xparam) |
| michael@0 | 82 | * </pre> |
| michael@0 | 83 | * |
| michael@0 | 84 | * @author Ben Fortuna |
| michael@0 | 85 | */ |
| michael@0 | 86 | public class DtStamp extends UtcProperty { |
| michael@0 | 87 | |
| michael@0 | 88 | private static final long serialVersionUID = 7581197869433744070L; |
| michael@0 | 89 | |
| michael@0 | 90 | /** |
| michael@0 | 91 | * Default constructor. Initialises the dateTime value to the time of instantiation. |
| michael@0 | 92 | */ |
| michael@0 | 93 | public DtStamp() { |
| michael@0 | 94 | super(DTSTAMP, PropertyFactoryImpl.getInstance()); |
| michael@0 | 95 | } |
| michael@0 | 96 | |
| michael@0 | 97 | /** |
| michael@0 | 98 | * @param aValue a string representation of a DTSTAMP value |
| michael@0 | 99 | * @throws ParseException if the specified value is not a valid representation |
| michael@0 | 100 | */ |
| michael@0 | 101 | public DtStamp(final String aValue) throws ParseException { |
| michael@0 | 102 | this(new ParameterList(), aValue); |
| michael@0 | 103 | } |
| michael@0 | 104 | |
| michael@0 | 105 | /** |
| michael@0 | 106 | * @param aList a list of parameters for this component |
| michael@0 | 107 | * @param aValue a value string for this component |
| michael@0 | 108 | * @throws ParseException where the specified value string is not a valid date-time/date representation |
| michael@0 | 109 | */ |
| michael@0 | 110 | public DtStamp(final ParameterList aList, final String aValue) |
| michael@0 | 111 | throws ParseException { |
| michael@0 | 112 | super(DTSTAMP, aList, PropertyFactoryImpl.getInstance()); |
| michael@0 | 113 | setValue(aValue); |
| michael@0 | 114 | } |
| michael@0 | 115 | |
| michael@0 | 116 | /** |
| michael@0 | 117 | * @param aDate a date representing a date-time |
| michael@0 | 118 | */ |
| michael@0 | 119 | public DtStamp(final DateTime aDate) { |
| michael@0 | 120 | super(DTSTAMP, PropertyFactoryImpl.getInstance()); |
| michael@0 | 121 | // time must be in UTC.. |
| michael@0 | 122 | aDate.setUtc(true); |
| michael@0 | 123 | setDate(aDate); |
| michael@0 | 124 | } |
| michael@0 | 125 | |
| michael@0 | 126 | /** |
| michael@0 | 127 | * @param aList a list of parameters for this component |
| michael@0 | 128 | * @param aDate a date representing a date-time |
| michael@0 | 129 | */ |
| michael@0 | 130 | public DtStamp(final ParameterList aList, final DateTime aDate) { |
| michael@0 | 131 | super(DTSTAMP, aList, PropertyFactoryImpl.getInstance()); |
| michael@0 | 132 | // time must be in UTC.. |
| michael@0 | 133 | aDate.setUtc(true); |
| michael@0 | 134 | setDate(aDate); |
| michael@0 | 135 | } |
| michael@0 | 136 | } |
