biweekly.property

Class Action

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.ValuedProperty<String>

biweekly.property.TextProperty

biweekly.property.EnumProperty

biweekly.property.Action

public class Action
extends EnumProperty

Defines the type of action to invoke when an alarm is triggered.

Code sample (creating):

 Action action = Action.audio();
 

Code sample (retrieving):

 ICalendar ical = ...
 for (VAlarm alarm : ical.getAlarms()){
   Action action = alarm.getAction();
   if (action.isAudio()) {
           ...
   } else if (action.isEmail()){
     ...
   } else if (action.isDisplay()){
     ...
   }
 }
 

Author:

Michael Angstadt

See Also:

RFC 5545 p.132-3, RFC 2445 p.126

Field Summary

Fields inherited from class biweekly.property.ValuedProperty

value

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
Action(Action original) Copy constructor.
Action(String value) Creates an action property.

Method Summary

Methods

Modifier and Type	Method and Description
static Action	audio() Creates an "audio" action property.
Action	copy() Creates a copy of this property object.
static Action	display() Creates an "display" action property.
static Action	email() Creates an "email" action property.
protected Collection<String>	getStandardValues(ICalVersion version) Gets the list of acceptable values for this property.
protected Collection<ICalVersion>	getValueSupportedVersions() Gets the iCalendar versions that this property's value is supported in.
boolean	isAudio() Determines if this property is an "audio" action.
boolean	isDisplay() Determines if this property is an "display" action.
boolean	isEmail() Determines if this property is an "email" action.
boolean	isProcedure() Determines if this property is a "procedure" action (vCal 1.0 only).
static Action	procedure() Creates a "procedure" action property (vCal 1.0 only).

Methods inherited from class biweekly.property.EnumProperty

equals, hashCode, is, validate

Methods inherited from class biweekly.property.ValuedProperty

getValue, getValue, setValue, toStringValues, valueEquals, valueHashCode

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

Action

public Action(String value)

Creates an action property. Use of this constructor is discouraged and may put the property in an invalid state. Use one of the static factory methods instead.

Parameters:

value - the value (e.g. "AUDIO")

Action

public Action(Action original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

audio

public static Action audio()

Creates an "audio" action property.

Returns:

the property

isAudio

public boolean isAudio()

Determines if this property is an "audio" action.

Returns:

true if it's an "audio" action, false if not

display

public static Action display()

Creates an "display" action property.

Returns:

the property

isDisplay

public boolean isDisplay()

Determines if this property is an "display" action.

Returns:

true if it's an "display" action, false if not

email

public static Action email()

Creates an "email" action property.

Returns:

the property

isEmail

public boolean isEmail()

Determines if this property is an "email" action.

Returns:

true if it's an "email" action, false if not

procedure

public static Action procedure()

Creates a "procedure" action property (vCal 1.0 only).

Returns:

the property

isProcedure

public boolean isProcedure()

Determines if this property is a "procedure" action (vCal 1.0 only).

Returns:

true if it's a "procedure" action, false if not

getStandardValues

protected Collection<String> getStandardValues(ICalVersion version)

Description copied from class: EnumProperty

Gets the list of acceptable values for this property.

Specified by:

getStandardValues in class EnumProperty

Parameters:

version - the version

Returns:

the list of acceptable values

getValueSupportedVersions

protected Collection<ICalVersion> getValueSupportedVersions()

Description copied from class: EnumProperty

Gets the iCalendar versions that this property's value is supported in. Meant to be overridden by the child class.

Overrides:

getValueSupportedVersions in class EnumProperty

Returns:

the supported versions

copy

public Action 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