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