Class AlarmTriggerRelationship

java.lang.Object

jfxtras.icalendarfx.VElementBase

jfxtras.icalendarfx.parameters.VParameterBase<AlarmTriggerRelationship, AlarmTriggerRelationship.AlarmTriggerRelationshipType>

jfxtras.icalendarfx.parameters.AlarmTriggerRelationship

All Implemented Interfaces:

VParameter<AlarmTriggerRelationship.AlarmTriggerRelationshipType>, VChild, VElement

public class AlarmTriggerRelationship
extends VParameterBase<AlarmTriggerRelationship, AlarmTriggerRelationship.AlarmTriggerRelationshipType>

3.2.14. Alarm Trigger Relationship

Parameter Name: RELATED

Purpose: To specify the relationship of the alarm trigger with respect to the start or end of the calendar component.

Description: This parameter can be specified on properties that specify an alarm trigger with a "DURATION" value type. The parameter specifies whether the alarm will trigger relative to the start or end of the calendar component. The parameter value START will set the alarm to trigger off the start of the calendar component; the parameter value END will set the alarm to trigger off the end of the calendar component. If the parameter is not specified on an allowable property, then the default is START.

Format Definition: This property parameter is defined by the following notation::

• triggerparam
  • "RELATED" "="
  • ("START" ; Trigger off of start
  • / "END") ; Trigger off of end

Example:

• TRIGGER;RELATED=END:PT5M

RFC 5545 iCalendar September 2009

Author:

David Bal

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AlarmTriggerRelationship.AlarmTriggerRelationshipType	Property value types for AlarmTriggerRelationship

Nested classes/interfaces inherited from class VElementBase

VElementBase.Message, VElementBase.MessageEffect

Field Summary

Fields inherited from class VParameterBase

converter, elementType

Fields inherited from class VElementBase

BEGIN, END

Constructor Summary

Constructors

Constructor	Description
AlarmTriggerRelationship()	Create default AlarmTriggerRelationship with property value set to START
AlarmTriggerRelationship(AlarmTriggerRelationship source)	Create deep copy of source AlarmTriggerRelationship
AlarmTriggerRelationship(AlarmTriggerRelationship.AlarmTriggerRelationshipType value)	Create new AlarmTriggerRelationshipType with property value set to input parameter

Method Summary

Modifier and Type	Method	Description
static AlarmTriggerRelationship	parse(String content)

Methods inherited from class VParameterBase

equals, errors, getParent, getValue, hashCode, name, parseContent, setParent, setValue, setValue, toString, withValue, withValue

Methods inherited from class VElementBase

elementName, isContentValid, newEmptyVElement, parse, throwMessageExceptions

Methods inherited from class Object

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

Methods inherited from interface VElement

isValid

Constructor Details

AlarmTriggerRelationship

public AlarmTriggerRelationship()

Create default AlarmTriggerRelationship with property value set to START

AlarmTriggerRelationship

public AlarmTriggerRelationship(AlarmTriggerRelationship.AlarmTriggerRelationshipType value)

Create new AlarmTriggerRelationshipType with property value set to input parameter

AlarmTriggerRelationship

public AlarmTriggerRelationship(AlarmTriggerRelationship source)

Create deep copy of source AlarmTriggerRelationship

Method Details

parse

public static AlarmTriggerRelationship parse(String content)