biweekly.property

Class DisplayAlarm

java.lang.Object

biweekly.property.ICalProperty

biweekly.property.VCalAlarmProperty

biweekly.property.DisplayAlarm

public class DisplayAlarm
extends VCalAlarmProperty

Defines an alarm that displays a message when triggered. It is recommended that the VAlarm component be used to created alarms.

Author:

Michael Angstadt

See Also:

vCal 1.0 p.30, VAlarm.display(biweekly.property.Trigger, java.lang.String)

Field Summary

Fields inherited from class biweekly.property.VCalAlarmProperty

repeat, snooze, start

Fields inherited from class biweekly.property.ICalProperty

parameters

Constructor Summary

Constructors

Constructor and Description
DisplayAlarm(DisplayAlarm original) Copy constructor.
DisplayAlarm(String text)

Method Summary

Methods

Modifier and Type	Method and Description
DisplayAlarm	copy() Creates a copy of this property object.
boolean	equals(Object obj)
String	getText() Gets the text to display when the alarm is triggered.
int	hashCode()
void	setText(String text) Sets the text to display when the alarm is triggered.
protected Map<String,Object>	toStringValues() Gets string representations of the class's fields for the ICalProperty.toString() method.

Methods inherited from class biweekly.property.VCalAlarmProperty

getRepeat, getSnooze, getStart, setRepeat, setSnooze, setStart

Methods inherited from class biweekly.property.ICalProperty

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DisplayAlarm

public DisplayAlarm(String text)

DisplayAlarm

public DisplayAlarm(DisplayAlarm original)

Copy constructor.

Parameters:

original - the property to make a copy of

Method Detail

getText

public String getText()

Gets the text to display when the alarm is triggered.

Returns:

the display text

setText

public void setText(String text)

Sets the text to display when the alarm is triggered.

Parameters:

text - the display text

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 VCalAlarmProperty

Returns:

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

copy

public DisplayAlarm 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 VCalAlarmProperty

equals

public boolean equals(Object obj)

Overrides:

equals in class VCalAlarmProperty