/
Calendar.java
349 lines (316 loc) · 11.5 KB
/
Calendar.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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
/**
* 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;
import net.fortuna.ical4j.model.component.CalendarComponent;
import net.fortuna.ical4j.model.property.CalScale;
import net.fortuna.ical4j.model.property.Method;
import net.fortuna.ical4j.model.property.ProdId;
import net.fortuna.ical4j.model.property.Version;
import net.fortuna.ical4j.util.Strings;
import net.fortuna.ical4j.validate.AbstractCalendarValidatorFactory;
import net.fortuna.ical4j.validate.ValidationException;
import net.fortuna.ical4j.validate.Validator;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import java.io.Serializable;
import java.net.URISyntaxException;
import java.text.ParseException;
import java.util.List;
/**
* $Id$ [Apr 5, 2004]
*
* Defines an iCalendar calendar.
*
* <pre>
* 4.6 Calendar Components
*
* The body of the iCalendar object consists of a sequence of calendar
* properties and one or more calendar components. The calendar
* properties are attributes that apply to the calendar as a whole. The
* calendar components are collections of properties that express a
* particular calendar semantic. For example, the calendar component can
* specify an event, a to-do, a journal entry, time zone information, or
* free/busy time information, or an alarm.
*
* The body of the iCalendar object is defined by the following
* notation:
*
* icalbody = calprops component
*
* calprops = 2*(
*
* ; 'prodid' and 'version' are both REQUIRED,
* ; but MUST NOT occur more than once
*
* prodid /version /
*
* ; 'calscale' and 'method' are optional,
* ; but MUST NOT occur more than once
*
* calscale /
* method /
*
* x-prop
*
* )
*
* component = 1*(eventc / todoc / journalc / freebusyc /
* / timezonec / iana-comp / x-comp)
*
* iana-comp = "BEGIN" ":" iana-token CRLF
*
* 1*contentline
*
* "END" ":" iana-token CRLF
*
* x-comp = "BEGIN" ":" x-name CRLF
*
* 1*contentline
*
* "END" ":" x-name CRLF
* </pre>
*
* Example 1 - Creating a new calendar:
*
* <pre><code>
* Calendar calendar = new Calendar();
* calendar.getProperties().add(new ProdId("-//Ben Fortuna//iCal4j 1.0//EN"));
* calendar.getProperties().add(Version.VERSION_2_0);
* calendar.getProperties().add(CalScale.GREGORIAN);
*
* // Add events, etc..
* </code></pre>
*
* @author Ben Fortuna
*/
public class Calendar implements Serializable {
private static final long serialVersionUID = -1654118204678581940L;
/**
* Begin token.
*/
public static final String BEGIN = "BEGIN";
/**
* Calendar token.
*/
public static final String VCALENDAR = "VCALENDAR";
/**
* End token.
*/
public static final String END = "END";
private final PropertyList properties;
private final ComponentList<CalendarComponent> components;
private final Validator<Calendar> validator;
/**
* Default constructor.
*/
public Calendar() {
this(new PropertyList(), new ComponentList<CalendarComponent>());
}
/**
* Constructs a new calendar with no properties and the specified components.
* @param components a list of components to add to the calendar
*/
public Calendar(final ComponentList<CalendarComponent> components) {
this(new PropertyList(), components);
}
/**
* Initialise a Calendar object using the default configured validator.
* @param properties a list of initial calendar properties
* @param components a list of initial calendar components
*/
public Calendar(PropertyList properties, ComponentList<CalendarComponent> components) {
this(properties, components, AbstractCalendarValidatorFactory.getInstance().newInstance());
}
/**
* Constructor.
* @param p a list of properties
* @param c a list of components
* @param validator used to ensure the validity of the calendar instance
*/
public Calendar(PropertyList p, ComponentList<CalendarComponent> c, Validator<Calendar> validator) {
this.properties = p;
this.components = c;
this.validator = validator;
}
/**
* Creates a deep copy of the specified calendar.
* @param c the calendar to copy
* @throws ParseException where calendar parsing fails
* @throws URISyntaxException where an invalid URI string is encountered
*/
public Calendar(Calendar c) throws ParseException, URISyntaxException {
this(new PropertyList(c.getProperties()),
new ComponentList<>(c.getComponents()));
}
/**
* {@inheritDoc}
*/
public final String toString() {
return BEGIN +
':' +
VCALENDAR +
Strings.LINE_SEPARATOR +
getProperties() +
getComponents() +
END +
':' +
VCALENDAR +
Strings.LINE_SEPARATOR;
}
/**
* @return Returns the components.
*/
public final ComponentList<CalendarComponent> getComponents() {
return components;
}
/**
* Convenience method for retrieving a list of named components.
* @param name name of components to retrieve
* @return a component list containing only components with the specified name
*/
public final <C extends CalendarComponent> ComponentList<C> getComponents(final String name) {
return getComponents().getComponents(name);
}
/**
* Convenience method for retrieving a named component.
* @param name name of the component to retrieve
* @return the first matching component in the component list with the specified name
*/
public final CalendarComponent getComponent(final String name) {
return getComponents().getComponent(name);
}
/**
* @return Returns the properties.
*/
public final PropertyList getProperties() {
return properties;
}
/**
* Convenience method for retrieving a list of named properties.
* @param name name of properties to retrieve
* @return a property list containing only properties with the specified name
*/
public final List<Property> getProperties(final String name) {
return getProperties().getProperties(name);
}
/**
* Convenience method for retrieving a named property.
* @param name name of the property to retrieve
* @return the first matching property in the property list with the specified name
*/
public final <T extends Property> T getProperty(final String name) {
return (T) getProperties().getProperty(name);
}
/**
* Perform validation on the calendar, its properties and its components in its current state.
* @throws ValidationException where the calendar is not in a valid state
*/
public final void validate() throws ValidationException {
validate(true);
}
/**
* Perform validation on the calendar in its current state.
* @param recurse indicates whether to validate the calendar's properties and components
* @throws ValidationException where the calendar is not in a valid state
*/
public void validate(final boolean recurse) throws ValidationException {
validator.validate(this);
if (recurse) {
validateProperties();
validateComponents();
}
}
/**
* Invoke validation on the calendar properties in its current state.
* @throws ValidationException where any of the calendar properties is not in a valid state
*/
private void validateProperties() throws ValidationException {
for (final Property property : getProperties()) {
property.validate();
}
}
/**
* Invoke validation on the calendar components in its current state.
* @throws ValidationException where any of the calendar components is not in a valid state
*/
private void validateComponents() throws ValidationException {
for (Component component : getComponents()) {
component.validate();
}
}
/**
* Returns the mandatory prodid property.
* @return the PRODID property, or null if property doesn't exist
*/
public final ProdId getProductId() {
return getProperty(Property.PRODID);
}
/**
* Returns the mandatory version property.
* @return the VERSION property, or null if property doesn't exist
*/
public final Version getVersion() {
return getProperty(Property.VERSION);
}
/**
* Returns the optional calscale property.
* @return the CALSCALE property, or null if property doesn't exist
*/
public final CalScale getCalendarScale() {
return getProperty(Property.CALSCALE);
}
/**
* Returns the optional method property.
* @return the METHOD property, or null if property doesn't exist
*/
public final Method getMethod() {
return getProperty(Property.METHOD);
}
/**
* {@inheritDoc}
*/
public final boolean equals(final Object arg0) {
if (arg0 instanceof Calendar) {
final Calendar calendar = (Calendar) arg0;
return new EqualsBuilder().append(getProperties(), calendar.getProperties())
.append(getComponents(), calendar.getComponents()).isEquals();
}
return super.equals(arg0);
}
/**
* {@inheritDoc}
*/
public final int hashCode() {
return new HashCodeBuilder().append(getProperties()).append(
getComponents()).toHashCode();
}
}