Module jfxtras.icalendarfx
Package jfxtras.icalendarfx.components

Class VLocatable<T>

java.lang.Object
jfxtras.icalendarfx.VElementBase
jfxtras.icalendarfx.VParentBase<T>
jfxtras.icalendarfx.components.VComponentBase<T>
jfxtras.icalendarfx.components.VCommon<T>
jfxtras.icalendarfx.components.VPrimary<T>
jfxtras.icalendarfx.components.VPersonal<T>
jfxtras.icalendarfx.components.VDisplayable<T>
jfxtras.icalendarfx.components.VLocatable<T>
All Implemented Interfaces:
VAttendee<T>, VComponent, VDescribable<T>, VDescribable2<T>, VDuration<T>, VLastModified<T>, VRepeatable<T>, VChild, VElement, VParent
Direct Known Subclasses:
NonStandardComponent, VEvent, VTodo
public abstract class VLocatable<T> extends VDisplayable<T> implements VDescribable2<T>, VDuration<T>

  • Field Details

    • description

      private Description description

    • duration

      private DurationProp duration
      DURATION RFC 5545 iCalendar 3.8.2.5 page 99, 3.3.6 page 34 Can't be used if DTEND is used. Must be one or the other. Example: DURATION:PT15M

    • geographicPosition

      private GeographicPosition geographicPosition
      GEO: Geographic Position RFC 5545 iCalendar 3.8.1.6 page 85, 3.3.6 page 85 This property specifies information related to the global position for the activity specified by a calendar component. This property value specifies latitude and longitude, in that order (i.e., "LAT LON" ordering). Example: GEO:37.386013;-122.082932

    • location

      private Location location
      LOCATION: RFC 5545 iCalendar 3.8.1.12. page 87 This property defines the intended venue for the activity defined by a calendar component. Example: LOCATION:Conference Room - F123\, Bldg. 002

    • priority

      private Priority priority
      PRIORITY RFC 5545 iCalendar 3.8.1.6 page 85, 3.3.6 page 85 This property defines the relative priority for a calendar component. This priority is specified as an integer in the range 0 to 9. Example: The following is an example of a property with the highest priority: PRIORITY:1

    • resources

      private List<Resources> resources

    • vAlarms

      private List<VAlarm> vAlarms

  • Constructor Details

    • VLocatable

      public VLocatable()

    • VLocatable

      public VLocatable(VLocatable<T> source)

  • Method Details

    • getDescription

      public Description getDescription()
      DESCRIPTION RFC 5545 iCalendar 3.8.1.5. page 84 This property provides a more complete description of the calendar component than that provided by the "SUMMARY" property. Example: DESCRIPTION:Meeting to provide technical review for "Phoenix" design.\nHappy Face Conference Room. Phoenix design team MUST attend this meeting.\nRSVP to team leader. Note: Only VJournal allows multiple instances of DESCRIPTION
      Specified by:
      getDescription in interface VDescribable2<T>

    • setDescription

      public void setDescription(Description description)
      Specified by:
      setDescription in interface VDescribable2<T>

    • getDuration

      public DurationProp getDuration()
      Description copied from interface: VDuration
      Gets the value of the DurationProp
      Specified by:
      getDuration in interface VDuration<T>

    • setDuration

      public void setDuration(DurationProp duration)
      Description copied from interface: VDuration
      Sets the value of the DurationProp
      Specified by:
      setDuration in interface VDuration<T>

    • getGeographicPosition

      public GeographicPosition getGeographicPosition()

    • setGeographicPosition

      public void setGeographicPosition(GeographicPosition geographicPosition)

    • setGeographicPosition

      public void setGeographicPosition(String geographicPosition)

    • setGeographicPosition

      public void setGeographicPosition(double latitude, double longitude)

    • withGeographicPosition

      public T withGeographicPosition(GeographicPosition geographicPosition)

    • withGeographicPosition

      public T withGeographicPosition(String geographicPosition)

    • withGeographicPosition

      public T withGeographicPosition(double latitude, double longitude)

    • getLocation

      public Location getLocation()

    • setLocation

      public void setLocation(Location location)

    • setLocation

      public void setLocation(String location)

    • withLocation

      public T withLocation(Location location)

    • withLocation

      public T withLocation(String location)

    • getPriority

      public Priority getPriority()

    • setPriority

      public void setPriority(Priority priority)

    • setPriority

      public void setPriority(String priority)

    • setPriority

      public void setPriority(int priority)

    • withPriority

      public T withPriority(Priority priority)

    • withPriority

      public T withPriority(String priority)

    • withPriority

      public T withPriority(int priority)

    • getResources

      public List<Resources> getResources()
      RESOURCES: RFC 5545 iCalendar 3.8.1.10. page 91 This property defines the equipment or resources anticipated for an activity specified by a calendar component. More than one resource can be specified as a COMMA-separated list Example: RESOURCES:EASEL,PROJECTOR,VCR RESOURCES;LANGUAGE=fr:Nettoyeur haute pression

    • setResources

      public void setResources(List<Resources> resources)

    • withResources

      public T withResources(List<Resources> resources)

    • withResources

      public T withResources(String... resources)

    • withResources

      public T withResources(Resources... resources)

    • getVAlarms

      public List<VAlarm> getVAlarms()
      VALARM Alarm Component RFC 5545 iCalendar 3.6.6. page 71 Provide a grouping of component properties that define an alarm. The "VALARM" calendar component MUST only appear within either a "VEVENT" or "VTODO" calendar component.

    • setVAlarms

      public void setVAlarms(List<VAlarm> vAlarms)

    • withVAlarms

      public T withVAlarms(List<VAlarm> vAlarms)

    • withVAlarms

      public T withVAlarms(VAlarm... vAlarms)

    • withVAlarms

      public T withVAlarms(String... vAlarms)

    • addSubcomponent

      void addSubcomponent(VComponent subcomponent)
      Description copied from class: VComponentBase
      Hook to add subcomponent such as #VAlarm, #StandardTime and #DaylightSavingTime
      Overrides:
      addSubcomponent in class VComponentBase<T>

    • errors

      public List<String> errors()
      Description copied from interface: VElement
      Produces a list of error messages indicating problems with calendar element VElement.errors() is invoked recursively to return errors of child elements in addition to errors in parent
      Specified by:
      errors in interface VElement
      Overrides:
      errors in class VDisplayable<T>
      Returns:
      - list of error messages

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class VParentBase<T>

    • streamRecurrences

      public Stream<Temporal> streamRecurrences(Temporal start)
      Stream recurrence dates with adjustment to include recurrences that don't end before start parameter
      Specified by:
      streamRecurrences in interface VRepeatable<T>
      Overrides:
      streamRecurrences in class VDisplayable<T>
      Parameters:
      start - - include recurrences that END before this value
      Returns:
      - stream of start dates or date/times for the recurrence set

    • eraseDateTimeProperties

      public void eraseDateTimeProperties()
      Description copied from class: VDisplayable
      Erase all date/time properties such as DTSTART, DTEND, DURATION, and DUE (which ever exist). This is necessary to prepare a CANCEL iTIP message for one recurrence instance.
      Overrides:
      eraseDateTimeProperties in class VDisplayable<T>

    • getActualDuration

      public abstract TemporalAmount getActualDuration()
      A convenience method that returns either Duration property value, or a calculated duration based on start and end values

    • setEndOrDuration

      public abstract void setEndOrDuration(Temporal startRecurrence, Temporal endRecurrence)
      A convenience method that sets DTEND, DURATION (VEvent) or DUE (VTodo) depending on which ever is already set to new value calculated by the duration or period between input parameters (depending on if the parameters are LocalDate or a date/time type (i.e. ZonedDateTime)) Note: In order to set DTEND, DTSTART must be assigned a value. DURATION and DUE doesn't require a DTSTART value.
      Parameters:
      startRecurrence -
      endRecurrence -