Caldavsync Sources / annotate

src/net/fortuna/ical4j/model/property/DtStart.java@fb9019fb1bf7 (annotated)

src/net/fortuna/ical4j/model/property/DtStart.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.Date;
michael@0 37 import net.fortuna.ical4j.model.ParameterList;
michael@0 38 import net.fortuna.ical4j.model.PropertyFactoryImpl;
michael@0 39 import net.fortuna.ical4j.model.TimeZone;
michael@0 40 import net.fortuna.ical4j.model.ValidationException;
michael@0 41
michael@0 42 /**
michael@0 43 * $Id$
michael@0 44 *
michael@0 45 * Created: [Apr 6, 2004]
michael@0 46 *
michael@0 47 * Defines a DTSTART iCalendar component property.
michael@0 48 *
michael@0 49 * <pre>
michael@0 50 * 4.8.2.4 Date/Time Start
michael@0 51 *
michael@0 52 * Property Name: DTSTART
michael@0 53 *
michael@0 54 * Purpose: This property specifies when the calendar component begins.
michael@0 55 *
michael@0 56 * Value Type: The default value type is DATE-TIME. The time value MUST
michael@0 57 * be one of the forms defined for the DATE-TIME value type. The value
michael@0 58 * type can be set to a DATE value type.
michael@0 59 *
michael@0 60 * Property Parameters: Non-standard, value data type, time zone
michael@0 61 * identifier property parameters can be specified on this property.
michael@0 62 *
michael@0 63 * Conformance: This property can be specified in the &quot;VEVENT&quot;, &quot;VTODO&quot;,
michael@0 64 * &quot;VFREEBUSY&quot;, or &quot;VTIMEZONE&quot; calendar components.
michael@0 65 *
michael@0 66 * Description: Within the &quot;VEVENT&quot; calendar component, this property
michael@0 67 * defines the start date and time for the event. The property is
michael@0 68 * REQUIRED in &quot;VEVENT&quot; calendar components. Events can have a start
michael@0 69 * date/time but no end date/time. In that case, the event does not take
michael@0 70 * up any time.
michael@0 71 *
michael@0 72 * Within the &quot;VFREEBUSY&quot; calendar component, this property defines the
michael@0 73 * start date and time for the free or busy time information. The time
michael@0 74 * MUST be specified in UTC time.
michael@0 75 *
michael@0 76 * Within the &quot;VTIMEZONE&quot; calendar component, this property defines the
michael@0 77 * effective start date and time for a time zone specification. This
michael@0 78 * property is REQUIRED within each STANDARD and DAYLIGHT part included
michael@0 79 * in &quot;VTIMEZONE&quot; calendar components and MUST be specified as a local
michael@0 80 * DATE-TIME without the &quot;TZID&quot; property parameter.
michael@0 81 *
michael@0 82 * Format Definition: The property is defined by the following notation:
michael@0 83 *
michael@0 84 * dtstart = &quot;DTSTART&quot; dtstparam &quot;:&quot; dtstval CRLF
michael@0 85 *
michael@0 86 * dtstparam = *(
michael@0 87 *
michael@0 88 * ; the following are optional,
michael@0 89 * ; but MUST NOT occur more than once
michael@0 90 *
michael@0 91 * (&quot;;&quot; &quot;VALUE&quot; &quot;=&quot; (&quot;DATE-TIME&quot; / &quot;DATE&quot;)) /
michael@0 92 * (&quot;;&quot; tzidparam) /
michael@0 93 *
michael@0 94 * ; the following is optional,
michael@0 95 * ; and MAY occur more than once
michael@0 96 *
michael@0 97 * *(&quot;;&quot; xparam)
michael@0 98 *
michael@0 99 * )
michael@0 100 *
michael@0 101 *
michael@0 102 *
michael@0 103 * dtstval = date-time / date
michael@0 104 * ;Value MUST match value type
michael@0 105 * </pre>
michael@0 106 *
michael@0 107 * @author Ben Fortuna
michael@0 108 */
michael@0 109 public class DtStart extends DateProperty {
michael@0 110
michael@0 111 private static final long serialVersionUID = -5707097476081111815L;
michael@0 112
michael@0 113 /**
michael@0 114 * Default constructor. The time value is initialised to the time of instantiation.
michael@0 115 */
michael@0 116 public DtStart() {
michael@0 117 super(DTSTART, PropertyFactoryImpl.getInstance());
michael@0 118 }
michael@0 119
michael@0 120 /**
michael@0 121 * Creates a new DTSTART property initialised with the specified timezone.
michael@0 122 * @param timezone initial timezone
michael@0 123 */
michael@0 124 public DtStart(TimeZone timezone) {
michael@0 125 super(DTSTART, timezone, PropertyFactoryImpl.getInstance());
michael@0 126 }
michael@0 127
michael@0 128 /**
michael@0 129 * @param aValue a value string for this component
michael@0 130 * @throws ParseException where the specified value string is not a valid date-time/date representation
michael@0 131 */
michael@0 132 public DtStart(final String aValue) throws ParseException {
michael@0 133 super(DTSTART, PropertyFactoryImpl.getInstance());
michael@0 134 setValue(aValue);
michael@0 135 }
michael@0 136
michael@0 137 /**
michael@0 138 * Creates a new DTSTART property initialised with the specified timezone and value.
michael@0 139 * @param value a string representation of a DTSTART value
michael@0 140 * @param timezone initial timezone
michael@0 141 * @throws ParseException where the specified value is not a valid string
michael@0 142 * representation
michael@0 143 */
michael@0 144 public DtStart(String value, TimeZone timezone) throws ParseException {
michael@0 145 super(DTSTART, timezone, PropertyFactoryImpl.getInstance());
michael@0 146 setValue(value);
michael@0 147 }
michael@0 148
michael@0 149 /**
michael@0 150 * @param aList a list of parameters for this component
michael@0 151 * @param aValue a value string for this component
michael@0 152 * @throws ParseException where the specified value string is not a valid date-time/date representation
michael@0 153 */
michael@0 154 public DtStart(final ParameterList aList, final String aValue)
michael@0 155 throws ParseException {
michael@0 156 super(DTSTART, aList, PropertyFactoryImpl.getInstance());
michael@0 157 setValue(aValue);
michael@0 158 }
michael@0 159
michael@0 160 /**
michael@0 161 * Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.
michael@0 162 * @param aDate a date
michael@0 163 */
michael@0 164 public DtStart(final Date aDate) {
michael@0 165 super(DTSTART, PropertyFactoryImpl.getInstance());
michael@0 166 setDate(aDate);
michael@0 167 }
michael@0 168
michael@0 169 /**
michael@0 170 * Constructs a new DtStart with the specified time.
michael@0 171 * @param time the time of the DtStart
michael@0 172 * @param utc specifies whether time is UTC
michael@0 173 */
michael@0 174 public DtStart(final Date time, final boolean utc) {
michael@0 175 super(DTSTART, PropertyFactoryImpl.getInstance());
michael@0 176 setDate(time);
michael@0 177 setUtc(utc);
michael@0 178 }
michael@0 179
michael@0 180 /**
michael@0 181 * Constructor. Date or Date-Time format is determined based on the presence of a VALUE parameter.
michael@0 182 * @param aList a list of parameters for this component
michael@0 183 * @param aDate a date
michael@0 184 */
michael@0 185 public DtStart(final ParameterList aList, final Date aDate) {
michael@0 186 super(DTSTART, aList, PropertyFactoryImpl.getInstance());
michael@0 187 setDate(aDate);
michael@0 188 }
michael@0 189
michael@0 190 /**
michael@0 191 * {@inheritDoc}
michael@0 192 */
michael@0 193 public final void validate() throws ValidationException {
michael@0 194 super.validate();
michael@0 195
michael@0 196 /*
michael@0 197 * ; the following are optional, ; but MUST NOT occur more than once (";" "VALUE" "=" ("DATE-TIME" / "DATE")) /
michael@0 198 * (";" tzidparam) /
michael@0 199 */
michael@0 200
michael@0 201 /*
michael@0 202 * ; the following is optional, ; and MAY occur more than once (";" xparam)
michael@0 203 */
michael@0 204 }
michael@0 205 }

Mercurial Repository: Caldavsync Sources

Europalab SCM Repository Server

mercurial