Module org.bzdev.base

Package org.bzdev.net.calendar

Class ICalBuilder.Journal

java.lang.Object

org.bzdev.net.calendar.ICalBuilder.Base

org.bzdev.net.calendar.ICalBuilder.Common

org.bzdev.net.calendar.ICalBuilder.Journal

Enclosing class:

ICalBuilder

public static class ICalBuilder.Journal
extends ICalBuilder.Common

The iCalendar journal component class. Please see Section 3.6.3 of RFC 5545 for a description of an iCalendar journal component.

Field Summary

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

contentLines

Constructor Summary

Constructors

Constructor	Description
Journal(String uid, int sequence, TemporalAccessor created, TemporalAccessor lastModified)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addDescription(String description, String... parameters)	Set the description for this event.
protected void	createContentLines()	Create the content for this event (a sequence of lines) that will make up part of an iCalendar file).
void	setStartTime(TemporalAccessor startTime, String... parameters)	Set the start time for this iCalendar component.
void	setSummary(String summary, String... parameters)	Set the summary property for this event.

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

addAttendee, addCategories, addComment, addContact, addRelatedTo, clearContentLines, setClassification, setDescription, setGeo, setLocation, setPriority, setStatus, 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

Journal

public Journal(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

setStartTime

public void setStartTime(TemporalAccessor startTime,
 String... parameters)
                  throws IllegalArgumentException

Set the start time for this iCalendar component. Please see Section 3.8.2.4 of RFC 5545 for a description of the start-time property. The parameters defined by RFC 5545 are

• VALUE. Values (which follow an "=" character) can be DATE-TIME or DATE.
• TZID. Please see Section 3.2.19 of RFC 5545.

The type of the TemporalAccessor argument 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().

Overrides:

setStartTime in class ICalBuilder.Common

Parameters:

startTime - the time at which the activity represented by this iCalendar component starts

parameters - the parameters

Throws:

IllegalArgumentException - the temporal accessor argument's type is not a recognized subclass of TemporalAccesssor

setSummary

public void setSummary(String summary,
 String... parameters)

Set the summary property for this event. The first argument is typically a short string describing an event and is described in Section 3.8.1.12 of RFC 5545.

Parameters defined by RFC 5545 for a comment are LANGUAGE and ALTREP.

Overrides:

setSummary in class ICalBuilder.Common

Parameters:

summary - a summary describing this event; null if there is no summary

parameters - the parameters for this property

addDescription

public void addDescription(String description,
 String... parameters)

Set the description for this event. The description of an iCalendar component and is described in Section 3.8.1.5 of RFC 5545.

Parameters defined by RFC 5545 for a comment are LANGUAGE and ALTREP.

Parameters:

description - a full description of this event; null if there is no description

parameters - the parameters for this property

createContentLines

protected void createContentLines()

Description copied from class: ICalBuilder.Common

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