Module org.bzdev.base

Package org.bzdev.net.calendar

Class ICalBuilder.Event

java.lang.Object

org.bzdev.net.calendar.ICalBuilder.Base

org.bzdev.net.calendar.ICalBuilder.Common

org.bzdev.net.calendar.ICalBuilder.CommonWithAlarm

org.bzdev.net.calendar.ICalBuilder.Event

Enclosing class:

ICalBuilder

public static class ICalBuilder.Event
extends ICalBuilder.CommonWithAlarm

The iCalendar event component class. Please see Section 3.6.1 of RFC 5545 for a description of an iCalendar event component.

Field Summary

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

contentLines

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	createContentLines()	Create the content for this event (a sequence of lines) that will make up part of an iCalendar file).
void	setDescription(String description, String... parameters)	Set the description for this event.
void	setEndTime(TemporalAccessor endTime, String... params)	Set the ending time for this iCalendar component.
void	setLocation(String location, String... parameters)	Set the location for this iCalendar component.
void	setPriority(int priority)	Set the priority of this iCalendar component.
void	setStartTime(TemporalAccessor startTime, String... params)	Set the starting time for this iCalendar component.
void	setStatus(ICalBuilder.Status status)	Set the status for this iCalendar component The status property is described in Section 3.8.1.11 of RFC 5545.
void	setSummary(String summary, String... parameters)	Set the summary property for this event.
void	setTransparent()	Indicate that this component is transparent (that is, it will not 'hide' other calendar components or prevent them from being present over the same time interval).

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

clearContentLines

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

addAttendee, addCategories, addComment, addContact, addRelatedTo, setClassification, setGeo, 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

Event

public Event(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 - a unique identifier labeling this event

sequence - the sequence number for updates for this event

created - the time at which this event was created

lastModified - the last time at which this event 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... params)

Set the starting time for this iCalendar component. Please see Section 3.8.2.4 of RFC 5545 for a description of the start-time property Parameters should not be used unless the run-time type of the first argument is LocalDate or LocalDateTime. 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 this item starts; null if there is no start time

params - the parameters for the starting time, if any

Throws:

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

setEndTime

public void setEndTime(TemporalAccessor endTime,
 String... params)

Set the ending time for this iCalendar component. Section 3.8.2.2 of RFC 5545 for a description of the end-time property. Parameters should not be used unless the run-time type of the first argument is LocalDate or LocalDateTime. 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.

Parameters:

endTime - the time at which this item ends; null if there is no end time

params - the parameters for the starting time, if any

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

setDescription

public void setDescription(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.

Overrides:

setDescription in class ICalBuilder.Common

Parameters:

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

parameters - the parameters for this property

setLocation

public void setLocation(String location,
 String... parameters)

Set the location for this iCalendar component. The location property describes the location of an event and is described in Section 3.8.1.7 of RFC 5545.

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

Overrides:

setLocation in class ICalBuilder.Common

Parameters:

location - the location for this event; null if no location is specified

parameters - the parameters for this property

setStatus

public void setStatus(ICalBuilder.Status status)
               throws IllegalArgumentException

Set the status for this iCalendar component The status property is described in Section 3.8.1.11 of RFC 5545.

Overrides:

setStatus in class ICalBuilder.Common

Parameters:

status - the status (ICalBuilder.Status.TENTATIVE, ICalBuilder.Status.CONFIRMED, or ICalBuilder.Status.CANCELLED); null to indicate that their is no status.

Throws:

IllegalArgumentException - the status is not allowed for this iCalendar component

setPriority

public void setPriority(int priority)

Set the priority of this iCalendar component. Please see Section 3.8.1.9 of RFC 5545 for a description of the priority property.

Overrides:

setPriority in class ICalBuilder.Common

Parameters:

priority - the priority, a value in the range [0, 9]

setTransparent

public void setTransparent()

Indicate that this component is transparent (that is, it will not 'hide' other calendar components or prevent them from being present over the same time interval). Section 3.8.2.7 of RFC 5545.

createContentLines

protected void createContentLines()

Description copied from class: ICalBuilder.CommonWithAlarm

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

Overrides:

createContentLines in class ICalBuilder.CommonWithAlarm