com.aspose.email

Class CalendarReader

java.lang.Object

com.aspose.email.CalendarReader

public class CalendarReader
extends Object

Allows read the calendar with multi events to the Appointment object from a file or stream.

Constructor Summary

Constructors

Constructor and Description
CalendarReader(InputStream stream) Initializes a new instance of CalendarReader with source stream and default Appointment LoadOptions.
CalendarReader(InputStream stream, AppointmentLoadOptions options) Initializes a new instance of CalendarReader with source stream and Appointment LoadOptions.
CalendarReader(String path) Initializes a new instance of CalendarReader with source file and default Appointment LoadOptions.
CalendarReader(String path, AppointmentLoadOptions options) Initializes a new instance of CalendarReader with source file and Appointment LoadOptions.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCount() Gets the number of Vevent components.
Appointment	getCurrent() Current read event.
int	getMethod() Gets the iCalendar object method type associated with the calendar object.
String	getVersion() Gets the Version of calendar.
boolean	isMultiEvents() Gets whether calendar contains multi events.
List<Appointment>	loadAsMultiple() Loads a list of events from a calendar with multiple events.
boolean	nextEvent() Reads next Event from source and save it to the Current.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CalendarReader

public CalendarReader(String path)

Initializes a new instance of CalendarReader with source file and default Appointment LoadOptions.

Parameters:

path - Path to source file.

CalendarReader

public CalendarReader(String path,
              AppointmentLoadOptions options)

Initializes a new instance of CalendarReader with source file and Appointment LoadOptions.

Parameters:

path - Path to source file.

options - Additional LoadOptions.

CalendarReader

public CalendarReader(InputStream stream)

Initializes a new instance of CalendarReader with source stream and default Appointment LoadOptions.

Parameters:

stream - Source stream.

CalendarReader

public CalendarReader(InputStream stream,
              AppointmentLoadOptions options)

Initializes a new instance of CalendarReader with source stream and Appointment LoadOptions.

Parameters:

stream - Source stream.

options - Additional LoadOptions.

Method Detail

getCurrent

public final Appointment getCurrent()

Current read event.

getVersion

public final String getVersion()

Gets the Version of calendar.

getCount

public final int getCount()

Gets the number of Vevent components.

isMultiEvents

public final boolean isMultiEvents()

Gets whether calendar contains multi events.

getMethod

public final int getMethod()

Gets the iCalendar object method type associated with the calendar object.

loadAsMultiple

public final List<Appointment> loadAsMultiple()

Loads a list of events from a calendar with multiple events.

Returns:

nextEvent

public final boolean nextEvent()

Reads next Event from source and save it to the Current.

Returns:

True if success otherwise false.