biweekly.property

Class Trigger

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.Trigger

public class Trigger
extends ICalProperty

Defines when to trigger an alarm.

Code sample:

 //15 minutes before the start time
 Duration duration = Duration.builder().prior(true).minutes(15).build();
 Trigger trigger = new Trigger(duration, Related.START);
 VAlarm alarm = VAlarm.display(trigger, "Meeting in 15 minutes");
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.133-6, RFC 2445 p.127-9

Field Summary

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
Trigger(Date date) Creates a trigger property.
Trigger(Duration duration, Related related) Creates a trigger property.
Trigger(Trigger original) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Trigger	copy() Creates a copy of this property object.
boolean	equals(Object obj)
Date	getDate() Gets the date-time that the alarm will trigger.
Duration	getDuration() Gets the relative time at which the alarm will trigger.
Related	getRelated() Gets the date-time field that the duration is relative to.
int	hashCode()
void	setDate(Date date) Sets the date-time that the alarm will trigger.
void	setDuration(Duration duration, Related related) Sets a relative time at which the alarm will trigger.
void	setRelated(Related related) Sets the date-time field that the duration is relative to.
protected Map<String,Object>	toStringValues() Gets string representations of the class's fields for the ICalProperty.toString() method.
protected void	validate(List<ICalComponent> components, ICalVersion version, List<Warning> warnings) Checks the property for data consistency problems or deviations from the specifications.

Methods inherited from class biweekly.property.ICalProperty

addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Trigger

public Trigger(Duration duration,
       Related related)

Creates a trigger property.

Parameters:

duration - the relative time

related - the date-time field that the duration is relative to

Trigger

public Trigger(Date date)

Creates a trigger property.

Parameters:

date - the date-time the alarm will trigger.

Trigger

public Trigger(Trigger original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

getDuration

public Duration getDuration()

Gets the relative time at which the alarm will trigger.

Returns:

the relative time or null if an absolute time is set

setDuration

public void setDuration(Duration duration,
               Related related)

Sets a relative time at which the alarm will trigger.

Parameters:

duration - the relative time

related - the date-time field that the duration is relative to

getDate

public Date getDate()

Gets the date-time that the alarm will trigger.

Returns:

the date-time or null if a relative duration is set

setDate

public void setDate(Date date)

Sets the date-time that the alarm will trigger.

Parameters:

date - the date-time the alarm will trigger.

getRelated

public Related getRelated()

Gets the date-time field that the duration is relative to.

Returns:

the field or null if not set

See Also:

RFC 5545 p.24

setRelated

public void setRelated(Related related)

Sets the date-time field that the duration is relative to.

Parameters:

related - the field or null to remove

See Also:

RFC 5545 p.24

validate

protected void validate(List<ICalComponent> components,
            ICalVersion version,
            List<Warning> warnings)

Description copied from class: ICalProperty

Checks the property for data consistency problems or deviations from the specifications.

This method should be overridden by child classes that wish to provide validation logic. The default implementation of this method does nothing.

Overrides:

validate in class ICalProperty

Parameters:

components - the hierarchy of components that the property belongs to

version - the version to validate against

warnings - the list to add the warnings to

toStringValues

protected Map<String,Object> toStringValues()

Description copied from class: ICalProperty

Gets string representations of the class's fields for the ICalProperty.toString() method.

Meant to be overridden by child classes. The default implementation returns an empty map.

Overrides:

toStringValues in class ICalProperty

Returns:

the values of the class's fields (key = field name, value = field value)

copy

public Trigger copy()

Description copied from class: ICalProperty

Creates a copy of this property object.

The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.

The child class's copy constructor, if present, MUST invoke the ICalProperty.ICalProperty(ICalProperty) super constructor to ensure that the parameters are also copied.

This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the property (such as in the ICalendar class's copy constructor ).

Overrides:

copy in class ICalProperty

Returns:

the copy

hashCode

public int hashCode()

Overrides:

hashCode in class ICalProperty

equals

public boolean equals(Object obj)

Overrides:

equals in class ICalProperty