jfxtras.icalendarfx.parameters

Class AlarmTriggerRelationship

java.lang.Object

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

jfxtras.icalendarfx.parameters.AlarmTriggerRelationship

All Implemented Interfaces:

java.lang.Comparable<Parameter<AlarmTriggerRelationship.AlarmTriggerRelationshipType>>, Parameter<AlarmTriggerRelationship.AlarmTriggerRelationshipType>, VChild, VElement

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

<h2> 3.2.14. Alarm Trigger Relationship</h2>

<p>Parameter Name:  RELATED</p>

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

<p>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.</p>

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

<ul> <li>trigrelparam <ul> <li>"RELATED" "=" <li>("START" ; Trigger off of start <li>/ "END") ; Trigger off of end </ul> </ul> <p>Example: <ul> <li>TRIGGER;RELATED=END:PT5M </ul> </p> RFC 5545 iCalendar September 2009

Property Summary

Properties inherited from class jfxtras.icalendarfx.parameters.ParameterBase

valueProperty

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static AlarmTriggerRelationship	parse(java.lang.String unfoldedContent) Create new AlarmTriggerRelationship by parsing unfolded calendar content

Methods inherited from class jfxtras.icalendarfx.parameters.ParameterBase

compareTo, equals, errors, getParent, getValue, hashCode, name, parameterType, parseContent, setParent, setValue, toContent, toString, valueProperty, withValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface jfxtras.icalendarfx.parameters.Parameter

extractName, extractValue

Methods inherited from interface jfxtras.icalendarfx.VElement

isValid

Constructor Detail

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 Detail

parse

public static AlarmTriggerRelationship parse(java.lang.String unfoldedContent)

Create new AlarmTriggerRelationship by parsing unfolded calendar content