VJournal (ical4j 4.0.0-alpha6 API)

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

public class VJournal
extends CalendarComponent

$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

Nested Classes
Modifier and Type	Class	Description
`static class`	`VJournal.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, END, EXPERIMENTAL_PREFIX, properties, VALARM, VAVAILABILITY, VEVENT, VFREEBUSY, VJOURNAL, 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

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`Optional<Clazz>`	`getClassification()`	Deprecated. use `Component.getProperty(String)`
`Optional<Created>`	`getCreated()`	Deprecated. use `Component.getProperty(String)`
`Optional<DtStamp>`	`getDateStamp()`	Deprecated. use `Component.getProperty(String)`
`Optional<Description>`	`getDescription()`	Deprecated. use `Component.getProperty(String)`
`Optional<LastModified>`	`getLastModified()`	Deprecated. use `Component.getProperty(String)`
`Optional<Organizer>`	`getOrganizer()`	Deprecated. use `Component.getProperty(String)`
`Optional<RecurrenceId<?>>`	`getRecurrenceId()`	Deprecated. use `Component.getProperty(String)`
`Optional<Sequence>`	`getSequence()`	Deprecated. use `Component.getProperty(String)`
`Optional<DtStart<?>>`	`getStartDate()`	Deprecated. use `Component.getProperty(String)`
`Optional<Status>`	`getStatus()`	Deprecated. use `Component.getProperty(String)`
`Optional<Summary>`	`getSummary()`	Deprecated. use `Component.getProperty(String)`
`Optional<Uid>`	`getUid()`	Deprecated. use `Component.getProperty(String)`
`Optional<Url>`	`getUrl()`	Deprecated. use `Component.getProperty(String)`
`protected ComponentFactory<VJournal>`	`newFactory()`	Returns a new component factory used to create deep copies.
`void`	`validate(boolean recurse)`	Perform validation on a component.
`void`	`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
add, calculateRecurrenceSet, copy, equals, getName, getProperties, getProperties, getProperty, getRequiredProperty, getValue, hashCode, remove, removeAll, replace, setProperties, toString, validate, validateProperties

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 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 final void 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 void 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
  - getClassification
```
@Deprecated
public final Optional<Clazz> getClassification()
```
    Deprecated. use Component.getProperty(String)
    
    Returns:
    
    the optional access classification property for a journal entry
  - getCreated
```
@Deprecated
public final Optional<Created> getCreated()
```
    Deprecated. use Component.getProperty(String)
    
    Returns:
    
    the optional creation-time property for a journal entry
  - getDescription
```
@Deprecated
public final Optional<Description> getDescription()
```
    Deprecated. use Component.getProperty(String)
    
    Returns:
    
    the optional description property for a journal entry
  - getStartDate
```
@Deprecated
public final Optional<DtStart<?>> getStartDate()
```
    Deprecated. use Component.getProperty(String)
    
    Convenience method to pull the DTSTART out of the property list.
    
    Returns:
    
    The DtStart object representation of the start Date
  - getLastModified
```
@Deprecated
public final Optional<LastModified> getLastModified()
```
    Deprecated. use Component.getProperty(String)
    
    Returns:
    
    the optional last-modified property for a journal entry
  - getOrganizer
```
@Deprecated
public final Optional<Organizer> getOrganizer()
```
    Deprecated. use Component.getProperty(String)
    
    Returns:
    
    the optional organizer property for a journal entry
  - getDateStamp
```
@Deprecated
public final Optional<DtStamp> getDateStamp()
```
    Deprecated. use Component.getProperty(String)
    
    Returns:
    
    the optional date-stamp property
  - getSequence
```
@Deprecated
public final Optional<Sequence> getSequence()
```
    Deprecated. use Component.getProperty(String)
    
    Returns:
    
    the optional sequence number property for a journal entry
  - getStatus
```
@Deprecated
public final Optional<Status> getStatus()
```
    Deprecated. use Component.getProperty(String)
    
    Returns:
    
    the optional status property for a journal entry
  - getSummary
```
@Deprecated
public final Optional<Summary> getSummary()
```
    Deprecated. use Component.getProperty(String)
    
    Returns:
    
    the optional summary property for a journal entry
  - getUrl
```
@Deprecated
public final Optional<Url> getUrl()
```
    Deprecated. use Component.getProperty(String)
    
    Returns:
    
    the optional URL property for a journal entry
  - getRecurrenceId
```
@Deprecated
public final Optional<RecurrenceId<?>> getRecurrenceId()
```
    Deprecated. use Component.getProperty(String)
    
    Returns:
    
    the optional recurrence identifier property for a journal entry
  - getUid
```
@Deprecated
public final Optional<Uid> getUid()
```
    Deprecated. use Component.getProperty(String)
    
    Returns the UID property of this component if available.
    
    Returns:
    
    a Uid instance, or null if no UID property exists
  - 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

Class VJournal

Nested Class Summary

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

VJournal

VJournal

VJournal

VJournal

Method Detail

validate

validate

getClassification

getCreated

getDescription

getStartDate

getLastModified

getOrganizer

getDateStamp

getSequence

getStatus

getSummary

getUrl

getRecurrenceId

getUid

newFactory