diff -r 000000000000 -r fb9019fb1bf7 src/net/fortuna/ical4j/model/property/Trigger.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/net/fortuna/ical4j/model/property/Trigger.java Tue Feb 10 18:12:00 2015 +0100 @@ -0,0 +1,288 @@ +/** + * 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 java.text.ParseException; + +import net.fortuna.ical4j.model.DateTime; +import net.fortuna.ical4j.model.Dur; +import net.fortuna.ical4j.model.Parameter; +import net.fortuna.ical4j.model.ParameterList; +import net.fortuna.ical4j.model.PropertyFactoryImpl; +import net.fortuna.ical4j.model.ValidationException; +import net.fortuna.ical4j.model.parameter.Value; +import net.fortuna.ical4j.util.ParameterValidator; + +/** + * $Id$ + * + * Created: [Apr 6, 2004] + * + * Defines a TRIGGER iCalendar component property. + * + * 
+ *     4.8.6.3 Trigger
+ *     
+ *        Property Name: TRIGGER
+ *     
+ *        Purpose: This property specifies when an alarm will trigger.
+ *     
+ *        Value Type: The default value type is DURATION. The value type can be
+ *        set to a DATE-TIME value type, in which case the value MUST specify a
+ *        UTC formatted DATE-TIME value.
+ *     
+ *        Property Parameters: Non-standard, value data type, time zone
+ *        identifier or trigger relationship property parameters can be
+ *        specified on this property. The trigger relationship property
+ *        parameter MUST only be specified when the value type is DURATION.
+ *     
+ *        Conformance: This property MUST be specified in the "VALARM" calendar
+ *        component.
+ *     
+ *        Description: Within the "VALARM" calendar component, this property
+ *        defines when the alarm will trigger. The default value type is
+ *        DURATION, specifying a relative time for the trigger of the alarm.
+ *        The default duration is relative to the start of an event or to-do
+ *        that the alarm is associated with. The duration can be explicitly set
+ *     
+ *        to trigger from either the end or the start of the associated event
+ *        or to-do with the "RELATED" parameter. A value of START will set the
+ *        alarm to trigger off the start of the associated event or to-do. A
+ *        value of END will set the alarm to trigger off the end of the
+ *        associated event or to-do.
+ *     
+ *        Either a positive or negative duration may be specified for the
+ *        "TRIGGER" property. An alarm with a positive duration is triggered
+ *        after the associated start or end of the event or to-do. An alarm
+ *        with a negative duration is triggered before the associated start or
+ *        end of the event or to-do.
+ *     
+ *        The "RELATED" property parameter is not valid if the value type of
+ *        the property is set to DATE-TIME (i.e., for an absolute date and time
+ *        alarm trigger). If a value type of DATE-TIME is specified, then the
+ *        property value MUST be specified in the UTC time format. If an
+ *        absolute trigger is specified on an alarm for a recurring event or
+ *        to-do, then the alarm will only trigger for the specified absolute
+ *        date/time, along with any specified repeating instances.
+ *     
+ *        If the trigger is set relative to START, then the "DTSTART" property
+ *        MUST be present in the associated "VEVENT" or "VTODO" calendar
+ *        component. If an alarm is specified for an event with the trigger set
+ *        relative to the END, then the "DTEND" property or the "DSTART" and
+ *        "DURATION' properties MUST be present in the associated "VEVENT"
+ *        calendar component. If the alarm is specified for a to-do with a
+ *        trigger set relative to the END, then either the "DUE" property or
+ *        the "DSTART" and "DURATION' properties MUST be present in the
+ *        associated "VTODO" calendar component.
+ *     
+ *        Alarms specified in an event or to-do which is defined in terms of a
+ *        DATE value type will be triggered relative to 00:00:00 UTC on the
+ *        specified date. For example, if "DTSTART:19980205, then the duration
+ *        trigger will be relative to19980205T000000Z.
+ *     
+ *        Format Definition: The property is defined by the following notation:
+ *     
+ *          trigger    = "TRIGGER" (trigrel / trigabs)
+ *     
+ *          trigrel    = *(
+ *     
+ *                     ; the following are optional,
+ *                     ; but MUST NOT occur more than once
+ *     
+ *                       (";" "VALUE" "=" "DURATION") /
+ *                       (";" trigrelparam) /
+ *     
+ *                     ; the following is optional,
+ *                     ; and MAY occur more than once
+ *     
+ *                       (";" xparam)
+ *                       ) ":"  dur-value
+ *     
+ *          trigabs    = 1*(
+ *     
+ *                     ; the following is REQUIRED,
+ *                     ; but MUST NOT occur more than once
+ *     
+ *                       (";" "VALUE" "=" "DATE-TIME") /
+ *     
+ *                     ; the following is optional,
+ *                     ; and MAY occur more than once
+ *     
+ *                       (";" xparam)
+ *     
+ *                       ) ":" date-time
+ *
+ * + * @author Ben Fortuna + */ +public class Trigger extends UtcProperty { + + private static final long serialVersionUID = 5049421499261722194L; + + private Dur duration; + + /** + * Default constructor. + */ + public Trigger() { + super(TRIGGER, PropertyFactoryImpl.getInstance()); + } + + /** + * @param aList a list of parameters for this component + * @param aValue a value string for this component + */ + public Trigger(final ParameterList aList, final String aValue) { + super(TRIGGER, aList, PropertyFactoryImpl.getInstance()); + setValue(aValue); + } + + /** + * @param duration a duration in milliseconds + */ + public Trigger(final Dur duration) { + super(TRIGGER, PropertyFactoryImpl.getInstance()); + setDuration(duration); + } + + /** + * @param aList a list of parameters for this component + * @param duration a duration in milliseconds + */ + public Trigger(final ParameterList aList, final Dur duration) { + super(TRIGGER, aList, PropertyFactoryImpl.getInstance()); + setDuration(duration); + } + + /** + * @param dateTime a date representation of a date-time + */ + public Trigger(final DateTime dateTime) { + super(TRIGGER, PropertyFactoryImpl.getInstance()); + setDateTime(dateTime); + } + + /** + * @param aList a list of parameters for this component + * @param dateTime a date representation of a date-time + */ + public Trigger(final ParameterList aList, final DateTime dateTime) { + super(TRIGGER, aList, PropertyFactoryImpl.getInstance()); + setDateTime(dateTime); + } + + /** + * {@inheritDoc} + */ + public final void validate() throws ValidationException { + super.validate(); + + final Parameter relParam = getParameter(Parameter.RELATED); + final Parameter valueParam = getParameter(Parameter.VALUE); + + if (relParam != null || !Value.DATE_TIME.equals(valueParam)) { + + ParameterValidator.getInstance().assertOneOrLess(Parameter.RELATED, + getParameters()); + + ParameterValidator.getInstance().assertNullOrEqual(Value.DURATION, + getParameters()); + + if (getDuration() == null) { + throw new ValidationException("Duration value not specified"); + } + } + else { + ParameterValidator.getInstance().assertOne(Parameter.VALUE, + getParameters()); + + ParameterValidator.getInstance().assertNullOrEqual(Value.DATE_TIME, + getParameters()); + + if (getDateTime() == null) { + throw new ValidationException("DATE-TIME value not specified"); + } + } + } + + /** + * @return Returns the duration. + */ + public final Dur getDuration() { + return duration; + } + + /** + * {@inheritDoc} + */ + public final void setValue(final String aValue) { + try { + super.setValue(aValue); + duration = null; + } + catch (ParseException pe) { + duration = new Dur(aValue); + super.setDateTime(null); + } + } + + /** + * {@inheritDoc} + */ + public final String getValue() { + if (duration != null) { + return duration.toString(); + } + return super.getValue(); + } + + /** + * @param dateTime The dateTime to set. + */ + public final void setDateTime(final DateTime dateTime) { + super.setDateTime(dateTime); + duration = null; + getParameters().replace(Value.DATE_TIME); + } + + /** + * @param duration The duration to set. + */ + public final void setDuration(final Dur duration) { + this.duration = duration; + super.setDateTime(null); + // duration is the default value type for Trigger.. + if (getParameter(Parameter.VALUE) != null) { + getParameters().replace(Value.DURATION); + } + } +}