public class VJournal extends CalendarComponent
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.getProperties().add(new Description("1. Agenda.., 2. Action Items.."));
Modifier and Type | Class and Description |
---|---|
static class |
VJournal.Factory |
EMPTY_VALIDATOR
Constructor and Description |
---|
VJournal()
Default constructor.
|
VJournal(boolean initialise) |
VJournal(PropertyList properties)
Constructor.
|
VJournal(Temporal start,
String summary)
Constructs a new VJOURNAL instance associated with the specified time with the specified summary.
|
Modifier and Type | Method and Description |
---|---|
Component |
copy()
Create a (deep) copy of this component.
|
Optional<Clazz> |
getClassification()
Deprecated.
|
Optional<Created> |
getCreated()
Deprecated.
|
Optional<DtStamp> |
getDateStamp()
Deprecated.
|
Optional<Description> |
getDescription()
Deprecated.
|
Optional<LastModified> |
getLastModified()
Deprecated.
|
Optional<Organizer> |
getOrganizer()
Deprecated.
|
Optional<RecurrenceId<?>> |
getRecurrenceId()
Deprecated.
|
Optional<Sequence> |
getSequence()
Deprecated.
|
Optional<DtStart<?>> |
getStartDate()
Deprecated.
|
Optional<Status> |
getStatus()
Deprecated.
|
Optional<Summary> |
getSummary()
Deprecated.
|
Optional<Uid> |
getUid()
Deprecated.
|
Optional<Url> |
getUrl()
Deprecated.
|
void |
validate(boolean recurse)
Perform validation on a component.
|
void |
validate(Method method)
Performs method-specific ITIP validation.
|
validateAdd, validateCancel, validateCounter, validateDeclineCounter, validatePublish, validateRefresh, validateReply, validateRequest
calculateRecurrenceSet, equals, getName, getProperties, getProperties, getProperty, getRequiredProperty, hashCode, toString, validate, validateProperties
public VJournal()
public VJournal(boolean initialise)
public VJournal(PropertyList properties)
properties
- a list of propertiespublic final void validate(boolean recurse) throws ValidationException
validate
in class Component
recurse
- indicates whether to validate the component's propertiesValidationException
- where the component is not in a valid statepublic void validate(Method method) throws ValidationException
validate
in class CalendarComponent
method
- the applicable methodValidationException
- where the component does not comply with RFC2446@Deprecated public final Optional<Clazz> getClassification()
Component.getProperty(String)
@Deprecated public final Optional<Created> getCreated()
Component.getProperty(String)
@Deprecated public final Optional<Description> getDescription()
Component.getProperty(String)
@Deprecated public final Optional<DtStart<?>> getStartDate()
Component.getProperty(String)
@Deprecated public final Optional<LastModified> getLastModified()
Component.getProperty(String)
@Deprecated public final Optional<Organizer> getOrganizer()
Component.getProperty(String)
@Deprecated public final Optional<DtStamp> getDateStamp()
Component.getProperty(String)
@Deprecated public final Optional<Sequence> getSequence()
Component.getProperty(String)
@Deprecated public final Optional<Status> getStatus()
Component.getProperty(String)
@Deprecated public final Optional<Summary> getSummary()
Component.getProperty(String)
@Deprecated public final Optional<Url> getUrl()
Component.getProperty(String)
@Deprecated public final Optional<RecurrenceId<?>> getRecurrenceId()
Component.getProperty(String)
@Deprecated public final Optional<Uid> getUid()
Component.getProperty(String)