Interface ICalCodec

  • All Known Implementing Classes:
    ICal4JICalCodec

    public interface ICalCodec
    An iCal calendar encoder/decoder. It encodes the events of a calendar into the iCal format and decodes a calendar in iCal format into Silverpeas event calendar.
    • Method Detail

      • encode

        String encode​(List<CalendarEvent> events)
               throws EncodingException
        Encodes the specified events in a calendar into the iCal format. If the encoding process failed for an unexpected reason, then an EncodingException is thrown.
        Parameters:
        events - the calendar events to encode in the iCal format. If the list of events is null or empty, an IllegalArgumentException is thrown.
        Returns:
        the textual representation in iCal format of the events..
        Throws:
        EncodingException - a runtime exception that is thrown when an unexpected failure occurs while encoding the specified calendar events.