Package net.fortuna.ical4j.model.component

Class VJournal

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, ChangeManagementPropertyAccessor, ComponentContainer<Component>, ComponentListAccessor<Component>, DateTimePropertyAccessor, DescriptivePropertyAccessor, FluentComponent, PropertyContainer, PropertyListAccessor, RecurrenceSupport<VJournal>, RelationshipPropertyAccessor

public class VJournal
extends CalendarComponent
implements ComponentContainer<Component>, RecurrenceSupport<VJournal>, DescriptivePropertyAccessor, ChangeManagementPropertyAccessor, DateTimePropertyAccessor, RelationshipPropertyAccessor

$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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VJournal.Factory	Default factory.

Field Summary

Fields inherited from class net.fortuna.ical4j.model.component.CalendarComponent

EMPTY_VALIDATOR

Fields 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, VVENUE

Constructor Summary

Constructors

Constructor	Description
VJournal()	Default constructor.
VJournal(boolean initialise)
VJournal(Temporal start, String summary)	Constructs a new VJOURNAL instance associated with the specified time with the specified summary.
VJournal(PropertyList properties)	Constructor.

Method Summary

Modifier and Type	Method	Description
ComponentList<Component>	getComponentList()
Optional<DtStamp>	getDateStamp()	Deprecated. use ChangeManagementPropertyAccessor.getDateTimeStamp()
List<VLocation>	getLocations()
List<Participant>	getParticipants()
List<VResource>	getResources()
<T extends Temporal> Optional<DtStart<T>>	getStartDate()	Deprecated. use DateTimePropertyAccessor.getDateTimeStart()
protected ComponentFactory<VJournal>	newFactory()	Returns a new component factory used to create deep copies.
void	setComponentList(ComponentList<Component> components)
ValidationResult	validate(boolean recurse)	Perform validation on a component.
ValidationResult	validate(Method method)	Performs method-specific ITIP validation.

Methods inherited from class net.fortuna.ical4j.model.component.CalendarComponent

validateAdd, validateCancel, validateCounter, validateDeclineCounter, validatePublish, validateRefresh, validateReply, validateRequest

Methods inherited from class net.fortuna.ical4j.model.Component

calculateRecurrenceSet, copy, equals, getFluentTarget, getName, getProperties, getPropertyList, getValue, hashCode, setPropertyList, toString, validate, validateProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.fortuna.ical4j.model.ChangeManagementPropertyAccessor

getCreated, getDateTimeStamp, getLastModified, getSequence

Methods inherited from interface net.fortuna.ical4j.model.ComponentContainer

add, remove, replace

Methods inherited from interface net.fortuna.ical4j.model.ComponentListAccessor

getComponent, getComponents

Methods inherited from interface net.fortuna.ical4j.model.DateTimePropertyAccessor

getDateTimeCompleted, getDateTimeDue, getDateTimeEnd, getDateTimeStart, getDuration, getFreeBusyTime, getTimeTransparency

Methods inherited from interface net.fortuna.ical4j.model.DescriptivePropertyAccessor

addAttachment, getAttachments, getCategories, getClassification, getComments, getDescription, getGeographicPos, getLocation, getPercentComplete, getPriority, getStatus, getSummary, setCategories, setSummary

Methods inherited from interface net.fortuna.ical4j.model.FluentComponent

withProperty

Methods inherited from interface net.fortuna.ical4j.model.PropertyContainer

add, addAll, remove, removeAll, replace, setPropertyList

Methods inherited from interface net.fortuna.ical4j.model.PropertyListAccessor

getProperties, getProperty, getPropertyList, getRequiredProperty

Methods inherited from interface net.fortuna.ical4j.model.RecurrenceSupport

calculateRecurrenceSet, copy, getOccurrences

Methods inherited from interface net.fortuna.ical4j.model.RelationshipPropertyAccessor

getAttendees, getContact, getOrganizer, getRecurrenceId, getRelatedTo, getUid, getUrl

Constructor Detail

VJournal

public VJournal()

Default constructor.

VJournal

public VJournal(boolean initialise)

VJournal

public VJournal(PropertyList properties)

Constructor.

Parameters:

properties - a list of properties

VJournal

public VJournal(Temporal start,
                String summary)

Constructs a new VJOURNAL instance associated with the specified time with the specified summary.

Parameters:

start - the date the journal entry is associated with

summary - the journal summary

Method Detail

validate

public ValidationResult validate(boolean recurse)
                          throws ValidationException

Perform validation on a component.

Specified by:

validate in class Component

Parameters:

recurse - indicates whether to validate the component's properties

Throws:

ValidationException - where the component is not in a valid state

validate

public ValidationResult validate(Method method)
                          throws ValidationException

Performs method-specific ITIP validation.

Overrides:

validate in class CalendarComponent

Parameters:

method - the applicable method

Throws:

ValidationException - where the component does not comply with RFC2446

getParticipants

public final List<Participant> getParticipants()

getLocations

public final List<VLocation> getLocations()

getResources

public final List<VResource> getResources()

getComponentList

public ComponentList<Component> getComponentList()

Specified by:

getComponentList in interface ComponentListAccessor<Component>

Returns:

Returns the underlying component list.

setComponentList

public void setComponentList(ComponentList<Component> components)

Specified by:

setComponentList in interface ComponentContainer<Component>

getStartDate

@Deprecated
public final <T extends Temporal> Optional<DtStart<T>> getStartDate()

Deprecated.

use DateTimePropertyAccessor.getDateTimeStart()

Convenience method to pull the DTSTART out of the property list.

Returns:

The DtStart object representation of the start Date

getDateStamp

@Deprecated
public final Optional<DtStamp> getDateStamp()

Deprecated.

use ChangeManagementPropertyAccessor.getDateTimeStamp()

Returns:

the optional date-stamp property

newFactory

protected ComponentFactory<VJournal> newFactory()

Description copied from class: Component

Returns a new component factory used to create deep copies.

Specified by:

newFactory in class Component

Returns:

a component factory instance