ICalendarExporter (Silverpeas Core 6.4 API)

All Superinterfaces:

Exporter<Stream<CalendarEvent>>

All Known Implementing Classes:

ICal4JExporter
```
public interface ICalendarExporter
extends Exporter<Stream<CalendarEvent>>
```
An exporter of a stream of calendar events into an output stream of an iCalendar text.

Author:

mmoquillon

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`CALENDAR`	The name of the additional parameter in the descriptor that has the calendar concerned by the export.
`static String`	`HIDE_PRIVATE_DATA`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`exports(ExportDescriptor descriptor, Supplier<Stream<CalendarEvent>> supplier)`	Exports a the supplied stream of events of a given calendar into the output stream provided by the specified descriptor.
`static ICalendarExporter`	`get()`	Gets an instance of the implementation of the `ICalendarExporter` interface.

- Field Detail
  - CALENDAR
```
static final String CALENDAR
```
    The name of the additional parameter in the descriptor that has the calendar concerned by the export.
    
    See Also:
    
    Constant Field Values
  - HIDE_PRIVATE_DATA
```
static final String HIDE_PRIVATE_DATA
```
    See Also:
    
    Constant Field Values
- Method Detail
  - get
```
static ICalendarExporter get()
```
    Gets an instance of the implementation of the ICalendarExporter interface.
    
    Returns:
    
    an ICalendarExporter instance.
  - exports
```
void exports(ExportDescriptor descriptor,
             Supplier<Stream<CalendarEvent>> supplier)
      throws ExportException
```
    Exports a the supplied stream of events of a given calendar into the output stream provided by the specified descriptor. The calendar instance must be provided by the descriptor.
    
    Specified by:
    
    exports in interface Exporter<Stream<CalendarEvent>>
    
    Parameters:
    
    descriptor - the export descriptor that describes how the export has to be done.
    
    supplier - the supplier that provides what resource to export. It starts the export process by, for example, getting the resource from the Silverpeas data source.
    
    Throws:
    
    ExportException