net.fortuna.ical4j.model.component.VAlarm 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.property.*;
import net.fortuna.ical4j.validate.ComponentValidator;
import net.fortuna.ical4j.validate.ValidationException;
import net.fortuna.ical4j.validate.ValidationResult;
import java.time.Instant;
import java.time.temporal.TemporalAmount;
import java.util.Optional;
import java.util.stream.Collectors;
import static net.fortuna.ical4j.model.Property.*;
/**
* $Id$ [Apr 5, 2004]
*
* Defines an iCalendar VALARM component.
*
*
* 4.6.6 Alarm Component
*
* Component Name: VALARM
*
* Purpose: Provide a grouping of component properties that define an
* alarm.
*
* Formal Definition: A "VALARM" calendar component is defined by the
* following notation:
*
* alarmc = "BEGIN" ":" "VALARM" CRLF
* (audioprop / dispprop / emailprop / procprop)
* "END" ":" "VALARM" CRLF
*
* audioprop = 2*(
*
* ; 'action' and 'trigger' are both REQUIRED,
* ; but MUST NOT occur more than once
*
* action / trigger /
*
* ; 'duration' and 'repeat' are both optional,
* ; and MUST NOT occur more than once each,
* ; but if one occurs, so MUST the other
*
* duration / repeat /
*
* ; the following is optional,
* ; but MUST NOT occur more than once
*
* attach /
*
* ; the following is optional,
* ; and MAY occur more than once
*
* x-prop
*
* )
*
*
*
* dispprop = 3*(
*
* ; the following are all REQUIRED,
* ; but MUST NOT occur more than once
*
* action / description / trigger /
*
* ; 'duration' and 'repeat' are both optional,
* ; and MUST NOT occur more than once each,
* ; but if one occurs, so MUST the other
*
* duration / repeat /
*
* ; the following is optional,
* ; and MAY occur more than once
*
* *x-prop
*
* )
*
*
*
* emailprop = 5*(
*
* ; the following are all REQUIRED,
* ; but MUST NOT occur more than once
*
* action / description / trigger / summary
*
* ; the following is REQUIRED,
* ; and MAY occur more than once
*
* attendee /
*
* ; 'duration' and 'repeat' are both optional,
* ; and MUST NOT occur more than once each,
* ; but if one occurs, so MUST the other
*
* duration / repeat /
*
* ; the following are optional,
* ; and MAY occur more than once
*
* attach / x-prop
*
* )
*
*
*
* procprop = 3*(
*
* ; the following are all REQUIRED,
* ; but MUST NOT occur more than once
*
* action / attach / trigger /
*
* ; 'duration' and 'repeat' are both optional,
* ; and MUST NOT occur more than once each,
* ; but if one occurs, so MUST the other
*
* duration / repeat /
*
* ; 'description' is optional,
* ; and MUST NOT occur more than once
*
* description /
*
* ; the following is optional,
* ; and MAY occur more than once
*
* x-prop
*
* )
*
*
* Example 1 - Creating an alarm to trigger at a specific time:
*
*
* 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);
*
* VAlarm christmas = new VAlarm(cal.getTime());
*
*
* Example 2 - Creating an alarm to trigger one (1) hour before the scheduled start of the parent event/the parent todo
* is due:
*
*
* VAlarm reminder = new VAlarm(new Dur(0, -1, 0, 0));
*
* // repeat reminder four (4) more times every fifteen (15) minutes..
* reminder.add(new Repeat(4));
* reminder.add(new Duration(new Dur(0, 0, 15, 0)));
*
* // display a message..
* reminder.add(Action.DISPLAY);
* reminder.add(new Description("Progress Meeting at 9:30am"));
*
*
* @author Ben Fortuna
*/
public class VAlarm extends Component implements ComponentContainer, DescriptivePropertyAccessor,
LocationsAccessor {
private static final long serialVersionUID = -8193965477414653802L;
/**
* Default constructor.
*/
public VAlarm() {
super(VALARM);
}
/**
* Constructor.
* @param properties a list of properties
*/
public VAlarm(final PropertyList properties) {
super(VALARM, properties);
}
/**
* Constructs a new VALARM instance that will trigger at the specified time.
* @param trigger the time the alarm will trigger
*/
public VAlarm(final Instant trigger) {
this();
add(new Trigger(trigger));
}
/**
* Constructs a new VALARM instance that will trigger at the specified time relative to the event/todo component.
* @param trigger a duration of time relative to the parent component that the alarm will trigger at
*/
public VAlarm(final TemporalAmount trigger) {
this();
add(new Trigger(trigger));
}
/**
*
* @return Returns the underlying component list.
*/
@Override
public ComponentList getComponentList() {
return (ComponentList) components;
}
@Override
public void setComponentList(ComponentList components) {
this.components = components;
}
/**
* {@inheritDoc}
*/
@Override
public ValidationResult validate(final boolean recurse) throws ValidationException {
var result = new ValidationResult();
if (getAction().isPresent()) {
switch (getAction().get().getValue()) {
case "AUDIO":
result = ComponentValidator.VALARM_AUDIO.validate(this);
break;
case "DISPLAY":
result = ComponentValidator.VALARM_DISPLAY.validate(this);
break;
case "EMAIL":
result = ComponentValidator.VALARM_EMAIL.validate(this);
break;
}
} else {
result = ComponentValidator.VALARM_ITIP.validate(this);
}
if (recurse) {
result = result.merge(validateProperties());
}
return result;
}
/**
* Returns the mandatory action property.
* @return the ACTION property or null if not specified
* @deprecated use {@link VAlarm#getProperty(String)}
*/
@Deprecated
public final Optional getAction() {
return getProperty(ACTION);
}
/**
* Returns the mandatory trigger property.
* @return the TRIGGER property or null if not specified
* @deprecated use {@link VAlarm#getProperty(String)}
*/
@Deprecated
public final Optional getTrigger() {
return getProperty(TRIGGER);
}
/**
* Returns the optional duration property.
* @return the DURATION property or null if not specified
* @deprecated use {@link VAlarm#getProperty(String)}
*/
@Deprecated
public final Optional getDuration() {
return getProperty(DURATION);
}
/**
* Returns the optional repeat property.
* @return the REPEAT property or null if not specified
* @deprecated use {@link VAlarm#getProperty(String)}
*/
@Deprecated
public final Optional getRepeat() {
return getProperty(REPEAT);
}
/**
* Returns the optional attachment property.
* @return the ATTACH property or null if not specified
* @deprecated use {@link DescriptivePropertyAccessor#getAttachments()}
*/
@Deprecated
public final Optional getAttachment() {
return getProperty(ATTACH);
}
@Override
protected ComponentFactory newFactory() {
return new Factory();
}
@Override
public T copy() {
return (T) newFactory().createComponent(new PropertyList(getProperties().parallelStream()
.map(Property::copy).collect(Collectors.toList())),
new ComponentList<>(getComponents().parallelStream()
.map(c -> (T) c.copy()).collect(Collectors.toList())));
}
public static class Factory extends Content.Factory implements ComponentFactory {
public Factory() {
super(VALARM);
}
@Override
public VAlarm createComponent() {
return new VAlarm();
}
@Override
public VAlarm createComponent(PropertyList properties) {
return new VAlarm(properties);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy