Top Description Inners Fields Constructors Methods
net.fortuna.ical4j.model.component

public Class VJournal

extends CalendarComponent
implements Prototype<VJournal>, ComponentContainer<Component>, RecurrenceSupport<VJournal>, DescriptivePropertyAccessor, ChangeManagementPropertyAccessor, DateTimePropertyAccessor, RelationshipPropertyAccessor, ParticipantsAccessor, LocationsAccessor, ResourcesAccessor
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.ResourcesAccessor, net.fortuna.ical4j.model.ComponentContainer, net.fortuna.ical4j.model.ComponentListAccessor, net.fortuna.ical4j.model.LocationsAccessor, net.fortuna.ical4j.model.ParticipantsAccessor, net.fortuna.ical4j.model.RelationshipPropertyAccessor, net.fortuna.ical4j.model.PropertyContainer, net.fortuna.ical4j.model.PropertyListAccessor, net.fortuna.ical4j.model.DateTimePropertyAccessor, net.fortuna.ical4j.model.ChangeManagementPropertyAccessor, net.fortuna.ical4j.model.DescriptivePropertyAccessor, net.fortuna.ical4j.model.RecurrenceSupport, net.fortuna.ical4j.model.Prototype
Imports
net.fortuna.ical4j.model.*, net.fortuna.ical4j.model.property.DtStamp, .DtStart, .Method, .Summary, net.fortuna.ical4j.validate.*, java.time.temporal.Temporal, java.util.HashMap, .Map, .Optional, java.util.stream.Collectors

$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.."));
Author
Ben Fortuna

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VJournal.Factory

Default factory.

Field Summary

Modifier and TypeField and Description
private static final Map<Method, Validator<VJournal>>
private static final long
Inherited from net.fortuna.ical4j.model.component.CalendarComponent:
EMPTY_VALIDATOR

Constructor Summary

AccessConstructor and Description
public
VJournal()

Default constructor.

public
VJournal(boolean initialise)

public
VJournal(final PropertyList
a list of properties
properties
)

Constructor.

public
VJournal(final Temporal
the date the journal entry is associated with
start
,
final String
the journal summary
summary
)

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

Method Summary

Modifier and TypeMethod and Description
public VJournal
copy()

Overrides net.fortuna.ical4j.model.Component.copy.

Implements net.fortuna.ical4j.model.Prototype.copy.

Create a (deep) copy of this component.

public ComponentList<Component>

Returns:

Returns the underlying component list.
getComponentList
()

Implements net.fortuna.ical4j.model.ComponentListAccessor.getComponentList.

public final Optional<DtStamp>

Returns:

the optional date-stamp property
getDateStamp
()

public final <T extends Temporal> Optional<DtStart<T>>

Returns:

The DtStart object representation of the start Date
getStartDate
()

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

protected ComponentFactory<VJournal>
newFactory()

Implements abstract net.fortuna.ical4j.model.Component.newFactory.

Returns a new component factory used to create deep copies.

public void
public ValidationResult
validate(final boolean
indicates whether to validate the component's properties
recurse
)

Implements abstract net.fortuna.ical4j.model.Component.validate.

Perform validation on a component.

public ValidationResult
validate(Method
the applicable method
method
)

Overrides net.fortuna.ical4j.model.component.CalendarComponent.validate.

Performs method-specific ITIP validation.

Inherited from net.fortuna.ical4j.model.component.CalendarComponent:
validateAddvalidateCancelvalidateCountervalidateDeclineCountervalidatePublishvalidateRefreshvalidateReplyvalidateRequest

Field Detail

methodValidatorsback to summary
private static final Map<Method, Validator<VJournal>> methodValidators
serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.component.CalendarComponent.serialVersionUID.

Constructor Detail

VJournalback to summary
public VJournal()

Default constructor.

VJournalback to summary
public VJournal(boolean initialise)
VJournalback to summary
public VJournal(final PropertyList properties)

Constructor.

Parameters
properties:PropertyList

a list of properties

VJournalback to summary
public VJournal(final Temporal start, final String summary)

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

Parameters
start:Temporal

the date the journal entry is associated with

summary:String

the journal summary

Method Detail

copyback to summary
public VJournal copy()

Overrides net.fortuna.ical4j.model.Component.copy.

Implements net.fortuna.ical4j.model.Prototype.copy.

Doc from net.fortuna.ical4j.model.Component.copy.

Create a (deep) copy of this component.

Returns:VJournal

the component copy

Annotations
@Override
getComponentListback to summary
public ComponentList<Component> getComponentList()

Implements net.fortuna.ical4j.model.ComponentListAccessor.getComponentList.

Returns:ComponentList<Component>

Returns the underlying component list.

Annotations
@Override
getDateStampback to summary
public final Optional<DtStamp> getDateStamp()
Returns:Optional<DtStamp>

the optional date-stamp property

Annotations
@Deprecated
getStartDateback to summary
public final <T extends Temporal> Optional<DtStart<T>> getStartDate()

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

Returns:Optional<DtStart<T>>

The DtStart object representation of the start Date

Annotations
@Deprecated
newFactoryback to summary
protected ComponentFactory<VJournal> newFactory()

Implements abstract net.fortuna.ical4j.model.Component.newFactory.

Doc from net.fortuna.ical4j.model.Component.newFactory.

Returns a new component factory used to create deep copies.

Returns:ComponentFactory<VJournal>

a component factory instance

Annotations
@Override
setComponentListback to summary
public void setComponentList(ComponentList<Component> components)

Implements net.fortuna.ical4j.model.ComponentContainer.setComponentList.

Annotations
@Override
validateback to summary
public ValidationResult validate(final boolean recurse) throws ValidationException

Implements abstract net.fortuna.ical4j.model.Component.validate.

Doc from net.fortuna.ical4j.model.Component.validate.

Perform validation on a component.

Parameters
recurse:boolean

indicates whether to validate the component's properties

Annotations
@Override
Exceptions
ValidationException:
where the component is not in a valid state
validateback to summary
public ValidationResult validate(Method method) throws ValidationException

Overrides net.fortuna.ical4j.model.component.CalendarComponent.validate.

Performs method-specific ITIP validation.

Parameters
method:Method

the applicable method

Annotations
@Override
Exceptions
ValidationException:
where the component does not comply with RFC2446
net.fortuna.ical4j.model.component back to summary

public Class VJournal.Factory

extends Factory
implements ComponentFactory<VJournal>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.ComponentFactory

Default factory.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public VJournal
public VJournal
Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createComponentback to summary
public VJournal createComponent()

Implements net.fortuna.ical4j.model.ComponentFactory.createComponent.

Annotations
@Override
createComponentback to summary
public VJournal createComponent(PropertyList properties)

Implements net.fortuna.ical4j.model.ComponentFactory.createComponent.

Annotations
@Override