Class VCalendar
iCalendar Object
RFC 5545, 3.4, page 50
Parent calendar object represents a collection of calendaring and scheduling information
-
Nested Class Summary
Nested classes/interfaces inherited from class VElementBase
VElementBase.Message, VElementBase.MessageEffect -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate CalendarScaleprivate static final Stringprivate AbstractITIPFactoryprivate static final Stringprivate Methodprivate static final Stringprivate List<NonStandardProperty> Provides a framework for defining non-standard properties.private ProductIdentifierprivate VersionFields inherited from class VParentBase
contentLineGenerator, ordererFields inherited from class VElementBase
BEGIN, END -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionerrors()Produces a list of error messages indicating problems with calendar elementVElement.errors()is invoked recursively to return errors of child elements in addition to errors in parentCALSCALE: RFC 5545 iCalendar 3.7.1.get AbstractITIPFactory to handle processing input VCalendar based onMethodMETHOD: RFC 5545 iCalendar 3.7.2.PRODID: RFC 5545 iCalendar 3.7.3.List<? extends VComponent> getVComponents(VComponent vComponent) A convenience method that returns parent list of theVComponentparameter.VERSION: RFC 5545 iCalendar 3.7.4.VEVENT: RFC 5545 iCalendar 3.6.1.VFREEBUSY: RFC 5545 iCalendar 3.6.4.VJOURNAL: RFC 5545 iCalendar 3.6.3.VTIMEZONE: RFC 5545 iCalendar 3.6.5.VTODO: RFC 5545 iCalendar 3.6.2.importVComponent(String contentText) Deprecated.importVComponent(VComponent newVComponent) Deprecated.protected booleanisContentValid(String valueContent) name()Returns the name of the component as it would appear in the iCalendar content line.static VCalendar/ List<Callablestatic VCalendarCreates a new VCalendar calendar component by parsing a String of iCalendar content linesstatic VCalendarCreates a new VCalendar from an ics filestatic VCalendarparseICalendarFile(Path icsFilePath) Creates a new VCalendar from an ics filestatic VCalendarparseICalendarFile(Path icsFilePath, boolean useResourceStatus) Creates a new VCalendar from an ics fileprocessITIPMessage(String iTIPMessages) Process the exchange of iCalendar object according to the iTIP methods identifies in RFC 5546.processITIPMessage(Collection<VCalendar> iTIPMessages) Process the exchange of iCalendar object according to the iTIP methods identifies in RFC 5546 based on the methods ingetITIPFactory()processITIPMessage(VCalendar... iTIPMessages) Process the exchange of iCalendar object according to the iTIP methods identifies in RFC 5546 based on the methods ingetITIPFactory()voidsetCalendarScale(String calendarScale) voidsetCalendarScale(CalendarScale calendarScale) voidvoidvoidsetMethod(Method.MethodType method) voidsetMethodProcessFactory(AbstractITIPFactory iTIPFactory) set AbstractITIPFactory to handle processing input VCalendar based onMethodvoidsetNonStandard(List<NonStandardProperty> nonStandardProps) voidsetProductIdentifier(String productIdentifier) voidsetProductIdentifier(ProductIdentifier productIdentifier) voidsetVersion(String version) voidsetVersion(Version version) voidsetVEvents(List<VEvent> vEvents) voidsetVFreeBusys(List<VFreeBusy> vFreeBusys) voidsetVJournals(List<VJournal> vJournals) voidsetVTimeZones(List<VTimeZone> vTimeZones) voidwithCalendarScale(String calendarScale) withCalendarScale(CalendarScale calendarScale) withMethod(String method) withMethod(Method method) withMethod(Method.MethodType method) withNonStandard(String... nonStandardProps) Sets the value of theby parsing a vararg of iCalendar content text representing individualinvalid reference
#nonStandardProperty()NonStandardPropertyobjects.withNonStandard(List<NonStandardProperty> nonStandardProps) Sets the value of theinvalid reference
#nonStandardProperty()withNonStandard(NonStandardProperty... nonStandardProps) Sets the value of thefrom a vararg ofinvalid reference
#nonStandardProperty()NonStandardPropertyobjects.withProductIdentifier(String productIdentifier) withProductIdentifier(ProductIdentifier productIdentifier) withVersion(String version) withVersion(Version version) withVEvents(String... vEvents) withVEvents(List<VEvent> vEvents) withVEvents(VEvent... vEvents) withVFreeBusies(String... vFreeBusys) withVFreeBusies(List<VFreeBusy> vFreeBusys) withVFreeBusies(VFreeBusy... vFreeBusys) withVJournals(String... vJournals) withVJournals(List<VJournal> vJournals) withVJournals(VJournal... vJournals) withVTimeZones(String... vTimeZones) withVTimeZones(List<VTimeZone> vTimeZones) withVTimeZones(VTimeZone... vTimeZones) withVTodos(String... vTodos) withVTodos(List<VTodo> vTodos) withVTodos(VTodo... vTodos) Methods inherited from class VParentBase
addChild, addChild, addChild, addChildInternal, checkChild, childrenUnmodifiable, collectGetterMap, collectSetterMap, copyChildrenInto, equals, getGetter, getGetters, getSetter, getSetters, hashCode, orderChild, orderChild, orderChild, parseContent, parseContent, processInLineChild, removeChild, removeChild, replaceChild, replaceChild, toString, withChildMethods inherited from class VElementBase
elementName, newEmptyVElement, parse, throwMessageExceptions
-
Field Details
-
NAME
- See Also:
-
FIRST_CONTENT_LINE
- See Also:
-
LAST_CONTENT_LINE
- See Also:
-
calendarScale
-
method
-
productIdentifier
-
version
-
nonStandardProps
Provides a framework for defining non-standard properties. -
vEvents
-
vTodos
-
vJournals
-
vFreeBusys
-
vTimeZones
-
iTIPFactory
-
-
Constructor Details
-
VCalendar
public VCalendar()Creates an empty VCalendar -
VCalendar
Copy constructor
-
-
Method Details
-
name
-
getCalendarScale
CALSCALE: RFC 5545 iCalendar 3.7.1. page 76 This property defines the calendar scale used for the calendar information specified in the iCalendar object. This project is based on the Gregorian calendar scale. The Gregorian calendar scale is assumed if this property is not specified in the iCalendar object. It is expected that other calendar scales will be defined in other specifications or by future versions of iCalendar. The default value is "GREGORIAN" Example: CALSCALE:GREGORIAN -
setCalendarScale
-
setCalendarScale
-
withCalendarScale
-
withCalendarScale
-
getMethod
METHOD: RFC 5545 iCalendar 3.7.2. page 77 This property defines the iCalendar object method associated with the calendar object Example: METHOD:REQUEST -
setMethod
-
setMethod
-
setMethod
-
withMethod
-
withMethod
-
withMethod
-
getProductIdentifier
PRODID: RFC 5545 iCalendar 3.7.3. page 78 This property specifies the identifier for the product that created the iCalendar object This project is named JFxtras iCalendar Example: PRODID:-//JFxtras//JFXtras iCalendar 1.0//EN -
setProductIdentifier
-
setProductIdentifier
-
withProductIdentifier
-
withProductIdentifier
-
getVersion
VERSION: RFC 5545 iCalendar 3.7.4. page 79 This property specifies the identifier corresponding to the highest version number or the minimum and maximum range of the iCalendar specification that is required in order to interpret the iCalendar object. This project complies with version 2.0 Example: VERSION:2.0 -
setVersion
-
setVersion
-
withVersion
-
withVersion
-
withVersion
-
getNonStandard
-
setNonStandard
-
withNonStandard
Sets the value of theinvalid reference
#nonStandardProperty()- Returns:
- - this class for chaining
-
withNonStandard
Sets the value of theby parsing a vararg of iCalendar content text representing individualinvalid reference
#nonStandardProperty()NonStandardPropertyobjects.- Returns:
- - this class for chaining
-
withNonStandard
Sets the value of thefrom a vararg ofinvalid reference
#nonStandardProperty()NonStandardPropertyobjects.- Returns:
- - this class for chaining
-
getVEvents
-
setVEvents
-
withVEvents
-
withVEvents
-
withVEvents
-
getVTodos
-
setVTodos
-
withVTodos
-
withVTodos
-
withVTodos
-
getVJournals
-
setVJournals
-
withVJournals
-
withVJournals
-
withVJournals
-
getVFreeBusies
-
setVFreeBusys
-
withVFreeBusies
-
withVFreeBusies
-
withVFreeBusies
-
getVTimeZones
-
setVTimeZones
-
withVTimeZones
-
withVTimeZones
-
withVTimeZones
-
getVComponents
A convenience method that returns parent list of theVComponentparameter. Returns null if component is not in anyVComponentlist.- Parameters:
vComponent- - VComponent to look up
-
setMethodProcessFactory
set AbstractITIPFactory to handle processing input VCalendar based onMethod -
getITIPFactory
get AbstractITIPFactory to handle processing input VCalendar based onMethod -
processITIPMessage
Process the exchange of iCalendar object according to the iTIP methods identifies in RFC 5546 based on the methods ingetITIPFactory()- Parameters:
iTIPMessages- iTIP VCalendars to process withMethodpopulated- Returns:
- - log of process operation
-
processITIPMessage
Process the exchange of iCalendar object according to the iTIP methods identifies in RFC 5546 based on the methods ingetITIPFactory()- Parameters:
iTIPMessages- iTIP VCalendars to process withMethodpopulated- Returns:
- - log of process operation
-
processITIPMessage
Process the exchange of iCalendar object according to the iTIP methods identifies in RFC 5546. Input string can contain multiple iTIP VCALENDAR messages.- Parameters:
iTIPMessages- iTIP VCalendar Message strings- Returns:
- - log of process operation
-
importVComponent
Deprecated.Parse component text to new VComponent withREQUEST-STATUSproperties containing the result of the process, such as success message or error report.- Parameters:
contentText- iCalendar content lines- Returns:
- the created VComponent with
REQUEST-STATUSpopulated to indicate success or failuer.
-
importVComponent
Deprecated.Import new VComponent withREQUEST-STATUSproperties containing the result of the process, such as success message or error report.- Parameters:
contentText- iCalendar content lines- Returns:
- list of error messages if import failed, null if successful
-
errors
Description copied from interface:VElementProduces a list of error messages indicating problems with calendar elementVElement.errors()is invoked recursively to return errors of child elements in addition to errors in parent- Specified by:
errorsin interfaceVElement- Overrides:
errorsin classVParentBase<VCalendar>- Returns:
- - list of error messages
-
parse
-
parse
Creates a new VCalendar from an ics file- Parameters:
icsFilePath- path of ics file to parse- Returns:
- Created VCalendar
- Throws:
IOException
-
parseICalendarFile
public static VCalendar parseICalendarFile(Path icsFilePath, boolean useResourceStatus) throws IOException Creates a new VCalendar from an ics file- Parameters:
icsFilePath- path of ics file to parse- Returns:
- Created VCalendar
- Throws:
IOException
-
parseICalendarFile
Creates a new VCalendar from an ics file- Parameters:
icsFilePath- path of ics file to parse- Returns:
- Created VCalendar
- Throws:
IOException
-
isContentValid
- Overrides:
isContentValidin classVElementBase
-
parse
-