Trigger (ical4j 4.0.0-alpha2 API)

java.lang.Object
- net.fortuna.ical4j.model.Content
- - net.fortuna.ical4j.model.Property
  - - net.fortuna.ical4j.model.property.DateProperty<Instant>
    - - net.fortuna.ical4j.model.property.Trigger

All Implemented Interfaces:: Serializable

public class Trigger
extends DateProperty<Instant>

$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

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Trigger.Factory

Nested Classes
Modifier and Type	Class and Description
`static class`	`Trigger.Factory`

Field Summary
- Fields inherited from class net.fortuna.ical4j.model.Property
  ACKNOWLEDGED, ACTION, ATTACH, ATTENDEE, BUSYTYPE, CALSCALE, CATEGORIES, CLASS, COMMENT, COMPLETED, CONTACT, COUNTRY, CREATED, DESCRIPTION, DTEND, DTSTAMP, DTSTART, DUE, DURATION, EXDATE, EXPERIMENTAL_PREFIX, EXRULE, EXTENDED_ADDRESS, FREEBUSY, GEO, LAST_MODIFIED, LOCALITY, LOCATION, LOCATION_TYPE, METHOD, NAME, ORGANIZER, PERCENT_COMPLETE, POSTALCODE, PRIORITY, PRODID, RDATE, RECURRENCE_ID, REGION, RELATED_TO, REPEAT, REQUEST_STATUS, RESOURCES, RRULE, SEQUENCE, STATUS, STREET_ADDRESS, SUMMARY, TEL, TRANSP, TRIGGER, TZID, TZNAME, TZOFFSETFROM, TZOFFSETTO, TZURL, UID, URL, VERSION

Constructor Summary

Constructors
Constructor and Description
`Trigger()` Default constructor.
`Trigger(Dur duration)` Deprecated.
`Trigger(Instant dateTime)`
`Trigger(ParameterList aList, Dur duration)` Deprecated.
`Trigger(ParameterList aList, Instant dateTime)`
`Trigger(ParameterList aList, String aValue)`
`Trigger(ParameterList aList, TemporalAmount duration)`
`Trigger(TemporalAmount duration)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Property`	`copy()` Create a (deep) copy of this property.
`TemporalAmount`	`getDuration()`
`String`	`getValue()`
`void`	`setDate(Instant dateTime)` Sets the date value of this property.
`void`	`setDuration(TemporalAmount duration)`
`void`	`setValue(String aValue)` Default setValue() implementation.
`void`	`validate()` Perform validation on a property.

Methods inherited from class net.fortuna.ical4j.model.property.DateProperty
getDate, hashCode, isUtc

Methods inherited from class net.fortuna.ical4j.model.Property
equals, getName, getParameter, getParameters, getParameters, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Trigger
```
public Trigger()
```
    Default constructor.
  - Trigger
```
public Trigger(ParameterList aList,
               String aValue)
```
    Parameters:
    
    aList - a list of parameters for this component
    
    aValue - a value string for this component
  - Trigger
```
@Deprecated
public Trigger(Dur duration)
```
    Deprecated.
    
    Parameters:
    
    duration - a duration in milliseconds
  - Trigger
```
public Trigger(TemporalAmount duration)
```
    Parameters:
    
    duration - a duration in milliseconds
  - Trigger
```
@Deprecated
public Trigger(ParameterList aList,
                           Dur duration)
```
    Deprecated.
    
    Parameters:
    
    aList - a list of parameters for this component
    
    duration - a duration in milliseconds
  - Trigger
```
public Trigger(ParameterList aList,
               TemporalAmount duration)
```
    Parameters:
    
    aList - a list of parameters for this component
    
    duration - a duration in milliseconds
  - Trigger
```
public Trigger(Instant dateTime)
```
    Parameters:
    
    dateTime - a date representation of a date-time
  - Trigger
```
public Trigger(ParameterList aList,
               Instant dateTime)
```
    Parameters:
    
    aList - a list of parameters for this component
    
    dateTime - a date representation of a date-time
- Method Detail
  - validate
```
public final void validate()
                    throws ValidationException
```
    Perform validation on a property.
    
    Overrides:
    
    validate in class DateProperty<Instant>
    
    Throws:
    
    ValidationException - where the property is not in a valid state
  - getDuration
```
public final TemporalAmount getDuration()
```
    Returns:
    
    Returns the duration.
  - setValue
```
public final void setValue(String aValue)
```
    Default setValue() implementation. Allows for either DATE or DATE-TIME values. Note that this method will use the system default zone rules to parse the string value. For parsing string values in a different timezone use TemporalAdapter.parse(String, ZoneId) and DateProperty.setDate(Temporal).
    
    Overrides:
    
    setValue in class DateProperty<Instant>
    
    Parameters:
    
    aValue - a string representation of a DATE or DATE-TIME value
  - getValue
```
public final String getValue()
```
    Overrides:
    
    getValue in class DateProperty<Instant>
    
    Returns:
    
    the content value
  - setDate
```
public void setDate(Instant dateTime)
```
    Description copied from class: DateProperty
    
    Sets the date value of this property. The timezone and value of this instance will also be updated accordingly.
    
    Overrides:
    
    setDate in class DateProperty<Instant>
    
    Parameters:
    
    dateTime - The dateTime to set.
  - setDuration
```
public final void setDuration(TemporalAmount duration)
```
    Parameters:
    
    duration - The duration to set.
  - copy
```
public Property copy()
```
    Description copied from class: Property
    
    Create a (deep) copy of this property.
    
    Specified by:
    
    copy in class Property
    
    Returns:
    
    the copy of the property

Class Trigger

Nested Class Summary

Field Summary

Fields inherited from class net.fortuna.ical4j.model.Property

Constructor Summary

Method Summary

Methods inherited from class net.fortuna.ical4j.model.property.DateProperty

Methods inherited from class net.fortuna.ical4j.model.Property

Methods inherited from class java.lang.Object

Constructor Detail

Trigger

Trigger

Trigger

Trigger

Trigger

Trigger

Trigger

Trigger

Method Detail

validate

getDuration

setValue

getValue

setDate

setDuration

copy