java.lang.Object
net.fortuna.ical4j.model.Content
net.fortuna.ical4j.model.Component
net.fortuna.ical4j.model.component.CalendarComponent
net.fortuna.ical4j.model.component.VJournal
- All Implemented Interfaces:
Serializable,Comparable<Component>,ChangeManagementPropertyAccessor,ComponentContainer<Component>,ComponentListAccessor<Component>,DateTimePropertyAccessor,DescriptivePropertyAccessor,FluentComponent,LocationsAccessor,ParticipantsAccessor,PropertyContainer,PropertyListAccessor,Prototype<Component>,RecurrenceSupport<VJournal>,RelationshipPropertyAccessor,ResourcesAccessor
public class VJournal
extends CalendarComponent
implements ComponentContainer<Component>, RecurrenceSupport<VJournal>, DescriptivePropertyAccessor, ChangeManagementPropertyAccessor, DateTimePropertyAccessor, RelationshipPropertyAccessor, ParticipantsAccessor, LocationsAccessor, ResourcesAccessor
$Id$ [Apr 5, 2004]
Defines an iCalendar VJOURNAL component.
4.6.3 Journal Component
Component Name: VJOURNAL
Purpose: Provide a grouping of component properties that describe a
journal entry.
Formal Definition: A "VJOURNAL" calendar component is defined by the
following notation:
journalc = "BEGIN" ":" "VJOURNAL" CRLF
jourprop
"END" ":" "VJOURNAL" CRLF
jourprop = *(
; the following are optional,
; but MUST NOT occur more than once
class / created / description / dtstart / dtstamp /
last-mod / organizer / recurid / seq / status /
summary / uid / url /
; the following are optional,
; and MAY occur more than once
attach / attendee / categories / comment /
contact / exdate / exrule / related / rdate /
rrule / rstatus / x-prop
)
Example 1 - Creating a journal associated with an event:
DtStart meetingDate = (DtStart) meeting.getProperties().getProperty(
Property.DTSTART);
VJournal minutes = new VJournal(meetingDate.getTime(),
"Progress Meeting - Minutes");
// add timezone information..
TzId tzParam = meetingDate.getParameters().getParmaeter(Parameter.TZID);
minutes.getProperties().getProperty(Property.DTSTART).getParameters().add(
tzParam);
// add description..
minutes.add(new Description("1. Agenda.., 2. Action Items.."));
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from class net.fortuna.ical4j.model.component.CalendarComponent
EMPTY_VALIDATORFields inherited from class net.fortuna.ical4j.model.Component
AVAILABLE, BEGIN, components, END, EXPERIMENTAL_PREFIX, PARTICIPANT, properties, VALARM, VAVAILABILITY, VEVENT, VFREEBUSY, VJOURNAL, VLOCATION, VRESOURCE, VTIMEZONE, VTODO, VVENUEFields inherited from interface net.fortuna.ical4j.model.PropertyContainer
ADD_IF_NOT_PRESENT -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncopy()Create a (deep) copy of this component.Deprecated.Deprecated.protected ComponentFactory<VJournal>Returns a new component factory used to create deep copies.voidsetComponentList(ComponentList<Component> components) validate(boolean recurse) Perform validation on a component.Performs method-specific ITIP validation.Methods inherited from class net.fortuna.ical4j.model.component.CalendarComponent
validateAdd, validateCancel, validateCounter, validateDeclineCounter, validatePublish, validateRefresh, validateReply, validateRequestMethods inherited from class net.fortuna.ical4j.model.Component
calculateRecurrenceSet, compareTo, equals, getFluentTarget, getName, getProperties, getPropertyList, getUid, getValue, hashCode, setPropertyList, toString, validate, validatePropertiesMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface net.fortuna.ical4j.model.ChangeManagementPropertyAccessor
getCreated, getDateTimeStamp, getLastModified, getSequenceMethods inherited from interface net.fortuna.ical4j.model.ComponentContainer
add, remove, replace, withMethods inherited from interface net.fortuna.ical4j.model.ComponentListAccessor
getComponent, getComponentsMethods inherited from interface net.fortuna.ical4j.model.DateTimePropertyAccessor
getDateTimeCompleted, getDateTimeDue, getDateTimeEnd, getDateTimeStart, getDuration, getFreeBusyTime, getTimeTransparencyMethods inherited from interface net.fortuna.ical4j.model.DescriptivePropertyAccessor
getAttachments, getCategories, getClassification, getComments, getDescription, getGeographicPos, getLocation, getPercentComplete, getPriority, getStatus, getSummaryMethods inherited from interface net.fortuna.ical4j.model.FluentComponent
withPropertyMethods inherited from interface net.fortuna.ical4j.model.LocationsAccessor
getLocationsMethods inherited from interface net.fortuna.ical4j.model.ParticipantsAccessor
getParticipantsMethods inherited from interface net.fortuna.ical4j.model.PropertyContainer
add, addAll, remove, removeAll, removeIf, replace, setPropertyList, withMethods inherited from interface net.fortuna.ical4j.model.PropertyListAccessor
getProperties, getProperty, getProperty, getPropertyList, getRequiredProperty, getRequiredPropertyMethods inherited from interface net.fortuna.ical4j.model.RecurrenceSupport
calculateRecurrenceSet, getOccurrencesMethods inherited from interface net.fortuna.ical4j.model.RelationshipPropertyAccessor
getAttendees, getContact, getOrganizer, getRecurrenceId, getRelatedTo, getUrlMethods inherited from interface net.fortuna.ical4j.model.ResourcesAccessor
getResources
-
Constructor Details
-
VJournal
public VJournal()Default constructor. -
VJournal
public VJournal(boolean initialise) -
VJournal
Constructor.- Parameters:
properties- a list of properties
-
VJournal
Constructs a new VJOURNAL instance associated with the specified time with the specified summary.- Parameters:
start- the date the journal entry is associated withsummary- the journal summary
-
-
Method Details
-
validate
Perform validation on a component.- Specified by:
validatein classComponent- Parameters:
recurse- indicates whether to validate the component's properties- Throws:
ValidationException- where the component is not in a valid state
-
validate
Performs method-specific ITIP validation.- Overrides:
validatein classCalendarComponent- Parameters:
method- the applicable method- Throws:
ValidationException- where the component does not comply with RFC2446
-
getComponentList
- Specified by:
getComponentListin interfaceComponentListAccessor<Component>- Returns:
- Returns the underlying component list.
-
setComponentList
- Specified by:
setComponentListin interfaceComponentContainer<Component>
-
getStartDate
Deprecated.Convenience method to pull the DTSTART out of the property list.- Returns:
- The DtStart object representation of the start Date
-
getDateStamp
Deprecated.- Returns:
- the optional date-stamp property
-
newFactory
Description copied from class:ComponentReturns a new component factory used to create deep copies.- Specified by:
newFactoryin classComponent- Returns:
- a component factory instance
-
copy
Description copied from class:ComponentCreate a (deep) copy of this component.
-
ChangeManagementPropertyAccessor.getDateTimeStamp()