net.fortuna.ical4j.model.component.VEvent Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ical4j Show documentation
Show all versions of ical4j Show documentation
A Java library for reading and writing iCalendar (*.ics) files
/**
* 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.component;
import net.fortuna.ical4j.model.*;
import net.fortuna.ical4j.model.parameter.TzId;
import net.fortuna.ical4j.model.parameter.Value;
import net.fortuna.ical4j.model.property.*;
import net.fortuna.ical4j.util.CompatibilityHints;
import net.fortuna.ical4j.validate.*;
import net.fortuna.ical4j.validate.component.VEventValidator;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import java.time.temporal.Temporal;
import java.time.temporal.TemporalAmount;
import java.util.*;
import java.util.stream.Collectors;
import static net.fortuna.ical4j.model.Property.*;
import static net.fortuna.ical4j.model.property.immutable.ImmutableMethod.*;
import static net.fortuna.ical4j.model.property.immutable.ImmutableStatus.*;
import static net.fortuna.ical4j.model.property.immutable.ImmutableTransp.TRANSPARENT;
import static net.fortuna.ical4j.validate.ValidationRule.ValidationType.*;
/**
* $Id$ [Apr 5, 2004]
*
* Defines an iCalendar VEVENT component.
*
*
* 4.6.1 Event Component
*
* Component Name: "VEVENT"
*
* Purpose: Provide a grouping of component properties that describe an
* event.
*
* Format Definition: A "VEVENT" calendar component is defined by the
* following notation:
*
* eventc = "BEGIN" ":" "VEVENT" CRLF
* eventprop *alarmc
* "END" ":" "VEVENT" CRLF
*
* eventprop = *(
*
* ; the following are optional,
* ; but MUST NOT occur more than once
*
* class / created / description / dtstart / geo /
* last-mod / location / organizer / priority /
* dtstamp / seq / status / summary / transp /
* uid / url / recurid /
*
* ; either 'dtend' or 'duration' may appear in
* ; a 'eventprop', but 'dtend' and 'duration'
* ; MUST NOT occur in the same 'eventprop'
*
* dtend / duration /
*
* ; the following are optional,
* ; and MAY occur more than once
*
* attach / attendee / categories / comment /
* contact / exdate / exrule / rstatus / related /
* resources / rdate / rrule / x-prop
*
* )
*
*
* Example 1 - Creating a new all-day event:
*
*
* java.util.Calendar cal = java.util.Calendar.getInstance();
* cal.set(java.util.Calendar.MONTH, java.util.Calendar.DECEMBER);
* cal.set(java.util.Calendar.DAY_OF_MONTH, 25);
*
* VEvent christmas = new VEvent(cal.getTime(), "Christmas Day");
*
* // initialise as an all-day event..
* christmas.getProperties().getProperty(Property.DTSTART).getParameters().add(
* Value.DATE);
*
* // add timezone information..
* VTimeZone tz = VTimeZone.getDefault();
* TzId tzParam = new TzId(tz.getProperties().getProperty(Property.TZID)
* .getValue());
* christmas.getProperties().getProperty(Property.DTSTART).getParameters().add(
* tzParam);
*
*
* Example 2 - Creating an event of one (1) hour duration:
*
*
* java.util.Calendar cal = java.util.Calendar.getInstance();
* // tomorrow..
* cal.add(java.util.Calendar.DAY_OF_MONTH, 1);
* cal.set(java.util.Calendar.HOUR_OF_DAY, 9);
* cal.set(java.util.Calendar.MINUTE, 30);
*
* VEvent meeting = new VEvent(cal.getTime(), 1000 * 60 * 60, "Progress Meeting");
*
* // add timezone information..
* VTimeZone tz = VTimeZone.getDefault();
* TzId tzParam = new TzId(tz.getProperties().getProperty(Property.TZID)
* .getValue());
* meeting.getProperties().getProperty(Property.DTSTART).getParameters().add(
* tzParam);
*
*
* Example 3 - Retrieve a list of periods representing a recurring event in a specified range:
*
*
* Calendar weekday9AM = Calendar.getInstance();
* weekday9AM.set(2005, Calendar.MARCH, 7, 9, 0, 0);
* weekday9AM.set(Calendar.MILLISECOND, 0);
*
* Calendar weekday5PM = Calendar.getInstance();
* weekday5PM.set(2005, Calendar.MARCH, 7, 17, 0, 0);
* weekday5PM.set(Calendar.MILLISECOND, 0);
*
* // Do the recurrence until December 31st.
* Calendar untilCal = Calendar.getInstance();
* untilCal.set(2005, Calendar.DECEMBER, 31);
* untilCal.set(Calendar.MILLISECOND, 0);
*
* // 9:00AM to 5:00PM Rule
* Recur recur = new Recur(Recur.WEEKLY, untilCal.getTime());
* recur.getDayList().add(WeekDay.MO);
* recur.getDayList().add(WeekDay.TU);
* recur.getDayList().add(WeekDay.WE);
* recur.getDayList().add(WeekDay.TH);
* recur.getDayList().add(WeekDay.FR);
* recur.setInterval(3);
* recur.setWeekStartDay(WeekDay.MO.getDay());
* RRule rrule = new RRule(recur);
*
* Summary summary = new Summary("TEST EVENTS THAT HAPPEN 9-5 MON-FRI");
*
* weekdayNineToFiveEvents = new VEvent();
* weekdayNineToFiveEvents.add(rrule);
* weekdayNineToFiveEvents.add(summary);
* weekdayNineToFiveEvents.add(new DtStart(weekday9AM.getTime()));
* weekdayNineToFiveEvents.add(new DtEnd(weekday5PM.getTime()));
*
* // Test Start 04/01/2005, End One month later.
* // Query Calendar Start and End Dates.
* Calendar queryStartDate = Calendar.getInstance();
* queryStartDate.set(2005, Calendar.APRIL, 1, 14, 47, 0);
* queryStartDate.set(Calendar.MILLISECOND, 0);
* Calendar queryEndDate = Calendar.getInstance();
* queryEndDate.set(2005, Calendar.MAY, 1, 11, 15, 0);
* queryEndDate.set(Calendar.MILLISECOND, 0);
*
* // This range is monday to friday every three weeks, starting from
* // March 7th 2005, which means for our query dates we need
* // April 18th through to the 22nd.
* PeriodList periods = weekdayNineToFiveEvents.getPeriods(queryStartDate
* .getTime(), queryEndDate.getTime());
*
*
* @author Ben Fortuna
*/
public class VEvent extends CalendarComponent implements ComponentContainer, RecurrenceSupport,
DescriptivePropertyAccessor, ChangeManagementPropertyAccessor, DateTimePropertyAccessor,
RelationshipPropertyAccessor, AlarmsAccessor, ParticipantsAccessor, LocationsAccessor, ResourcesAccessor {
private static final long serialVersionUID = 2547948989200697335L;
private static final Map> methodValidators = new HashMap<>();
static {
methodValidators.put(ADD, new VEventValidator(
new ValidationRule<>(One, DTSTAMP, DTSTART, ORGANIZER, SEQUENCE, SUMMARY, UID),
new ValidationRule<>(OneOrLess, CATEGORIES, CLASS, CREATED, DESCRIPTION, DTEND, DURATION, GEO,
LAST_MODIFIED, LOCATION, PRIORITY, RESOURCES, STATUS, TRANSP, URL),
new ValidationRule<>(None, RECURRENCE_ID, REQUEST_STATUS)));
methodValidators.put(CANCEL, new VEventValidator(false,
new ValidationRule<>(One, DTSTAMP, DTSTART, ORGANIZER, SEQUENCE, UID),
new ValidationRule<>(OneOrLess, CATEGORIES, CLASS, CREATED, DESCRIPTION, DTEND, DTSTART, DURATION, GEO,
LAST_MODIFIED, LOCATION, PRIORITY, RECURRENCE_ID, RESOURCES, STATUS, SUMMARY, TRANSP, URL),
new ValidationRule<>(None, REQUEST_STATUS)));
methodValidators.put(COUNTER, new VEventValidator(
new ValidationRule<>(One, DTSTAMP, DTSTART, SEQUENCE, SUMMARY, UID),
new ValidationRule<>(One, true, ORGANIZER),
new ValidationRule<>(OneOrLess, CATEGORIES, CLASS, CREATED, DESCRIPTION, DTEND, DURATION, GEO,
LAST_MODIFIED, LOCATION, PRIORITY, RECURRENCE_ID, RESOURCES, STATUS, TRANSP, URL)));
methodValidators.put(DECLINE_COUNTER, new VEventValidator(false,
new ValidationRule<>(One, DTSTAMP, ORGANIZER, UID),
new ValidationRule<>(OneOrLess, RECURRENCE_ID, SEQUENCE),
new ValidationRule<>(None, ATTACH, ATTENDEE, CATEGORIES, CLASS, CONTACT, CREATED, DESCRIPTION, DTEND,
DTSTART, DURATION, EXDATE, EXRULE, GEO, LAST_MODIFIED, LOCATION, PRIORITY, RDATE, RELATED_TO,
RESOURCES, RRULE, STATUS, SUMMARY, TRANSP, URL)));
methodValidators.put(PUBLISH, new VEventValidator(
new ValidationRule<>(One, DTSTART, UID),
new ValidationRule<>(One, true, DTSTAMP, ORGANIZER, SUMMARY),
new ValidationRule<>(OneOrLess, RECURRENCE_ID, SEQUENCE, CATEGORIES, CLASS, CREATED, DESCRIPTION, DTEND,
DURATION, GEO, LAST_MODIFIED, LOCATION, PRIORITY, RESOURCES, STATUS, TRANSP, URL),
new ValidationRule<>(None, true, ATTENDEE),
new ValidationRule<>(None, REQUEST_STATUS)));
methodValidators.put(REFRESH, new VEventValidator(false,
new ValidationRule<>(One, ATTENDEE, DTSTAMP, ORGANIZER, UID),
new ValidationRule<>(OneOrLess, RECURRENCE_ID),
new ValidationRule<>(None, ATTACH, CATEGORIES, CLASS, CONTACT, CREATED, DESCRIPTION, DTEND, DTSTART,
DURATION, EXDATE, EXRULE, GEO, LAST_MODIFIED, LOCATION, PRIORITY, RDATE, RELATED_TO,
REQUEST_STATUS, RESOURCES, RRULE, SEQUENCE, STATUS, SUMMARY, TRANSP, URL)));
methodValidators.put(REPLY, new VEventValidator(CompatibilityHints.isHintEnabled(CompatibilityHints.KEY_RELAXED_VALIDATION),
new ValidationRule<>(One, ATTENDEE, DTSTAMP, ORGANIZER, UID),
new ValidationRule<>(OneOrLess, RECURRENCE_ID, SEQUENCE, CATEGORIES, CLASS, CREATED, DESCRIPTION, DTEND,
DTSTART, DURATION, GEO, LAST_MODIFIED, LOCATION, PRIORITY, RESOURCES, STATUS, SUMMARY, TRANSP,
URL)));
methodValidators.put(REQUEST, new VEventValidator(
new ValidationRule<>(OneOrMore, true, ATTENDEE),
new ValidationRule<>(One, DTSTAMP, DTSTART, ORGANIZER, SUMMARY, UID),
new ValidationRule<>(OneOrLess, SEQUENCE, CATEGORIES, CLASS, CREATED, DESCRIPTION, DTEND, DURATION, GEO,
LAST_MODIFIED, LOCATION, PRIORITY, RECURRENCE_ID, RESOURCES, STATUS, TRANSP, URL)));
}
/**
* Default constructor.
*/
public VEvent() {
this(true);
}
public VEvent(boolean initialise) {
super(VEVENT);
if (initialise) {
add(new DtStamp());
}
}
/**
* Constructor.
* @param properties a list of properties
*/
public VEvent(final PropertyList properties) {
super(VEVENT, properties);
}
/**
* Constructor.
* @param properties a list of properties
* @param alarms a list of alarms
*/
public VEvent(final PropertyList properties, final ComponentList alarms) {
super(VEVENT, properties, alarms);
}
/**
* Constructs a new VEVENT instance starting at the specified time with the specified summary.
* @param start the start date of the new event
* @param summary the event summary
*/
public VEvent(final Temporal start, final String summary) {
this();
add(new DtStart<>(start));
add(new Summary(summary));
}
/**
* Constructs a new VEVENT instance starting and ending at the specified times with the specified summary.
* @param start the start date of the new event
* @param end the end date of the new event
* @param summary the event summary
*/
public VEvent(final Temporal start, final Temporal end, final String summary) {
this();
add(new DtStart<>(start));
add(new DtEnd<>(end));
add(new Summary(summary));
}
/**
* Constructs a new VEVENT instance starting at the specified times, for the specified duration, with the specified
* summary.
* @param start the start date of the new event
* @param duration the duration of the new event
* @param summary the event summary
*/
public VEvent(final Temporal start, final TemporalAmount duration, final String summary) {
this();
add(new DtStart<>(start));
add(new Duration(duration));
add(new Summary(summary));
}
@Override
public ComponentList getComponentList() {
//noinspection unchecked
return (ComponentList) components;
}
@Override
public void setComponentList(ComponentList components) {
this.components = components;
}
/**
* {@inheritDoc}
*/
@Override
public ValidationResult validate(final boolean recurse) throws ValidationException {
var result = ComponentValidator.VEVENT.validate(this);
// validate that getAlarms() only contains VAlarm components
// final Iterator iterator = getAlarms().iterator();
// while (iterator.hasNext()) {
// final Component component = (Component) iterator.next();
//
// if (!(component instanceof VAlarm)) {
// throw new ValidationException("Component ["
// + component.getName() + "] may not occur in VEVENT");
// }
//
// ((VAlarm) component).validate(recurse);
// }
final Optional status = getStatus();
if (status.isPresent() && !VEVENT_TENTATIVE.getValue().equals(status.get().getValue())
&& !VEVENT_CONFIRMED.getValue().equals(status.get().getValue())
&& !VEVENT_CANCELLED.getValue().equals(status.get().getValue())) {
result.getEntries().add(new ValidationEntry("Status property ["
+ status + "] is not applicable for VEVENT", ValidationEntry.Severity.ERROR, getName()));
}
if (getDateTimeEnd().isPresent()) {
/*
* The "VEVENT" is also the calendar component used to specify an anniversary or daily reminder within a
* calendar. These events have a DATE value type for the "DTSTART" property instead of the default data type
* of DATE-TIME. If such a "VEVENT" has a "DTEND" property, it MUST be specified as a DATE value also. The
* anniversary type of "VEVENT" can span more than one date (i.e, "DTEND" property value is set to a
* calendar date after the "DTSTART" property value).
*/
final Optional> start = getDateTimeStart();
final Optional> end = getDateTimeEnd();
if (start.isPresent()) {
final Optional startValue = start.get().getParameter(Parameter.VALUE);
final Optional endValue = end.get().getParameter(Parameter.VALUE);
boolean startEndValueMismatch = false;
if (endValue.isPresent()) {
if (startValue.isPresent() && !endValue.equals(startValue)) {
// invalid..
startEndValueMismatch = true;
} else if (!startValue.isPresent() && !Value.DATE_TIME.equals(endValue.get())) {
// invalid..
startEndValueMismatch = true;
}
}
else if (startValue.isPresent() && !Value.DATE_TIME.equals(startValue.get())) {
//invalid..
startEndValueMismatch = true;
}
if (startEndValueMismatch) {
result.getEntries().add(new ValidationEntry("Property [" + Property.DTEND
+ "] must have the same [" + Parameter.VALUE
+ "] as [" + Property.DTSTART + "]", ValidationEntry.Severity.ERROR, getName()));
}
}
}
if (recurse) {
result = result.merge(validateProperties());
}
return result;
}
/**
* Performs method-specific ITIP validation.
* @param method the applicable method
* @throws ValidationException where the component does not comply with RFC2446
*/
public ValidationResult validate(Method method) throws ValidationException {
final Validator validator = methodValidators.get(method);
if (validator != null) {
return validator.validate(this);
}
else {
return super.validate(method);
}
}
/**
* Returns a normalised list of periods representing the consumed time for this event.
* @param range the range to check for consumed time
* @return a normalised list of periods representing consumed time for this event
*/
public final List> getConsumedTime(final Period range) {
return getConsumedTime(range, true);
}
/**
* Returns a list of periods representing the consumed time for this event in the specified range. Note that the
* returned list may contain a single period for non-recurring components or multiple periods for recurring
* components. If no time is consumed by this event an empty list is returned.
* @param range the range to check for consumed time
* @param normalise indicate whether the returned list of periods should be normalised
* @return a list of periods representing consumed time for this event
*/
public final List> getConsumedTime(final Period range, final boolean normalise) {
PeriodList periods;
// if component is transparent return empty list..
Optional transp = getTimeTransparency();
if (transp.isEmpty() || !TRANSPARENT.equals(transp.get())) {
// try {
periods = new PeriodList<>(calculateRecurrenceSet(range));
// }
// catch (ValidationException ve) {
// log.error("Invalid event data", ve);
// return periods;
// }
// if periods already specified through recurrence, return..
// ..also normalise before returning.
if (!periods.getPeriods().isEmpty() && normalise) {
periods = periods.normalise();
}
} else {
periods = new PeriodList<>();
}
return new ArrayList<>(periods.getPeriods());
}
/**
* Returns a single occurrence of a recurring event.
* @param date a date on which the occurence should occur
* @return a single non-recurring event instance for the specified date, or null if the event doesn't
* occur on the specified date
* @deprecated use {@link RecurrenceSupport#getOccurrences(Period)}
*/
@Deprecated
public final VEvent getOccurrence(final T date) {
final List> consumedTime = getConsumedTime(new Period<>(date, date));
for (final Period p : consumedTime) {
if (p.getStart().equals(date)) {
final VEvent occurrence = (VEvent) this.copy();
occurrence.add(new RecurrenceId<>(date));
return occurrence;
}
}
return null;
}
/**
* Convenience method to pull the DTSTART out of the property list.
* @return The DtStart object representation of the start Date
* @deprecated use {@link DateTimePropertyAccessor#getDateTimeStart()}
*/
@Deprecated
public final Optional> getStartDate() {
return getDateTimeStart();
}
/**
* @return the optional date-stamp property
* @deprecated use {@link ChangeManagementPropertyAccessor#getDateTimeStamp()}
*/
@Deprecated
public final Optional getDateStamp() {
return getDateTimeStamp();
}
/**
* @return the optional time transparency property for an event
* @deprecated use {@link DateTimePropertyAccessor#getTimeTransparency()}
*/
@Deprecated
public final Optional getTransparency() {
return getTimeTransparency();
}
/**
* Returns the end date of this event. Where an end date is not available it will be derived from the event
* duration.
* @return a DtEnd instance, or null if one cannot be derived
*/
public final Optional> getEndDate() {
return getEndDate(true);
}
/**
* Convenience method to pull the DTEND out of the property list. If DTEND was not specified, use the DTSTART +
* DURATION to calculate it.
* @param deriveFromDuration specifies whether to derive an end date from the event duration where an end date is
* not found
* @return The end for this VEVENT.
*/
public final Optional> getEndDate(final boolean deriveFromDuration) {
Optional> dtEnd = getDateTimeEnd();
// No DTEND? No problem, we'll use the DURATION.
if (dtEnd.isEmpty() && deriveFromDuration) {
Optional> dtStart = getDateTimeStart();
if (dtStart.isPresent()) {
final Duration vEventDuration;
Optional duration = getDuration();
if (duration.isPresent()) {
vEventDuration = duration.get();
} else if (dtStart.get().getParameter(Parameter.VALUE).equals(Optional.of(Value.DATE_TIME))) {
// If "DTSTART" is a DATE-TIME, then the event's duration is zero (see: RFC 5545, 3.6.1 Event Component)
vEventDuration = new Duration(java.time.Duration.ZERO);
} else {
// If "DTSTART" is a DATE, then the event's duration is one day (see: RFC 5545, 3.6.1 Event Component)
vEventDuration = new Duration(java.time.Duration.ofDays(1));
}
Optional tzId = dtStart.get().getParameter(Parameter.TZID);
DtEnd newdtEnd;
if (tzId.isPresent()) {
var dtendParams = new ParameterList(Collections.singletonList(tzId.get()));
//noinspection unchecked
newdtEnd = new DtEnd<>(dtendParams, (T) dtStart.get().getDate().plus(vEventDuration.getDuration()));
} else {
//noinspection unchecked
newdtEnd = new DtEnd<>((T) dtStart.get().getDate().plus(vEventDuration.getDuration()));
}
return Optional.of(newdtEnd);
}
}
return dtEnd;
}
/**
* {@inheritDoc}
*/
@Override
public boolean equals(final Object arg0) {
if (arg0 instanceof VEvent) {
return super.equals(arg0)
&& Objects.equals(getAlarms(), ((VEvent) arg0).getAlarms());
}
return super.equals(arg0);
}
/**
* {@inheritDoc}
*/
@Override
public int hashCode() {
return new HashCodeBuilder().append(getName()).append(getProperties())
.append(getAlarms()).toHashCode();
}
@Override
protected ComponentFactory newFactory() {
return new Factory();
}
@Override
public Component copy() {
return newFactory().createComponent(new PropertyList(getProperties().parallelStream()
.map(Prototype::copy).collect(Collectors.toList())),
new ComponentList<>(getComponents().parallelStream()
.map(Prototype::copy).collect(Collectors.toList())));
}
public static class Factory extends Content.Factory implements ComponentFactory {
public Factory() {
super(VEVENT);
}
@Override
public VEvent createComponent() {
return new VEvent(false);
}
@Override
public VEvent createComponent(PropertyList properties) {
return new VEvent(properties);
}
@Override @SuppressWarnings("unchecked")
public VEvent createComponent(PropertyList properties, ComponentList subComponents) {
return new VEvent(properties, (ComponentList) subComponents);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy