Module org.bzdev.base

Package org.bzdev.net.calendar

Class ICalBuilder.CommonWithAlarm

java.lang.Object

org.bzdev.net.calendar.ICalBuilder.Base

org.bzdev.net.calendar.ICalBuilder.Common

org.bzdev.net.calendar.ICalBuilder.CommonWithAlarm

Direct Known Subclasses:

ICalBuilder.Event, ICalBuilder.ToDo

Enclosing class:

ICalBuilder

public abstract static class ICalBuilder.CommonWithAlarm
extends ICalBuilder.Common

Superclass for those ICalendar components that can contain alarms.

Field Summary

Fields inherited from class org.bzdev.net.calendar.ICalBuilder.Base

contentLines

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CommonWithAlarm(String uid, int sequence, TemporalAccessor created, TemporalAccessor lastModified)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	clearContentLines()	Clear the content lines.
protected void	createContentLines()	Create the content for this event (a sequence of lines) that will make up part of an iCalendar file).

Methods inherited from class org.bzdev.net.calendar.ICalBuilder.Common

addAttendee, addCategories, addComment, addContact, addRelatedTo, setClassification, setDescription, setGeo, setLocation, setPriority, setStartTime, setStatus, setSummary, setURL

Methods inherited from class org.bzdev.net.calendar.ICalBuilder.Base

addAttachment, addAttachment, addProperty, addProperty, addProperty, setDuration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CommonWithAlarm

protected CommonWithAlarm(String uid,
 int sequence,
 TemporalAccessor created,
 TemporalAccessor lastModified)
                   throws IllegalArgumentException

Constructor. The first argument (uid) is described in Section 3.8.4.7 of RFC 5545. The second argument (sequence) is described in Section 3.8.7.4 of RFC 5545. The third argument (created) is described in Section 3.8.7.1 of RFC 5545. The fourth argument (lastModified) is described in Section of 3.8.7.3 RFC 5545.

The types of the TemporalAccessor arguments must be either LocalDate, LocalDateTime, ZonedDateTime, or Instant, The classesLocalDate and LocalDateTime will be treated as a "floating time" (see RFC 5545) and both ZonedDateTime and Instant will have their times represented using UTC. To convert a LocalDate value to a LocalDateTime value, use methods such as LocalDate.atStartOfDay(). To convert a LocalDateTime value to a ZonedDateTime object, use the method LocalDateTime.atZone(java.time.ZoneId). To get the default time zone for the Java virtual machine, use the method ZoneId.systemDefault().

Parameters:

uid - the globally unique identifier for this iCalendar component

sequence - a sequence number labeling changes to this iCalendar component

created - the time at which this iCalendar component was created

lastModified - the last time at which this iCalendar component was modified

Throws:

IllegalArgumentException - an argument was null or the sequence number was negative or a temporal accessor argument's type is not a recognized subclass of TemporalAccesssor

Method Details

clearContentLines

protected void clearContentLines()

Description copied from class: ICalBuilder.Base

Clear the content lines. Subclasses that override this method must call super.clearContentLines().

Overrides:

clearContentLines in class ICalBuilder.Common

createContentLines

protected void createContentLines()

Create the content for this event (a sequence of lines) that will make up part of an iCalendar file).

Overrides:

createContentLines in class ICalBuilder.Common