biweekly.io.text
Interface ICalRawReader.ICalDataStreamListener

Enclosing class:

ICalRawReader

public static interface ICalRawReader.ICalDataStreamListener

Handles the iCalendar data as it is read off the data stream. Each one of this interface's methods may throw a ICalRawReader.StopReadingException at any time to force the parser to stop reading from the data stream. This will cause the reader to return from the ICalRawReader.start(biweekly.io.text.ICalRawReader.ICalDataStreamListener) method. To continue reading from the data stream, simply call the ICalRawReader.start(biweekly.io.text.ICalRawReader.ICalDataStreamListener) method again.

Author:

Michael Angstadt

Method Summary

void	beginComponent(String name) Called when a component begins (when a "BEGIN:NAME" property is reached).
void	endComponent(String name) Called when a component ends (when a "END:NAME" property is reached).
void	invalidLine(String line) Called when a line cannot be parsed.
void	readProperty(String name, ICalParameters parameters, String value) Called when a property is read.
void	valuelessParameter(String propertyName, String parameterName) Called when a value-less parameter is read.

Method Detail

beginComponent

void beginComponent(String name)

Called when a component begins (when a "BEGIN:NAME" property is reached).

Parameters:

name - the component name (e.g. "VEVENT")

Throws:

ICalRawReader.StopReadingException - to force the reader to stop reading from the data stream

readProperty

void readProperty(String name,
                  ICalParameters parameters,
                  String value)

Called when a property is read.

Parameters:

name - the property name (e.g. "VERSION")

parameters - the parameters

value - the property value

Throws:

ICalRawReader.StopReadingException - to force the reader to stop reading from the data stream

endComponent

void endComponent(String name)

Called when a component ends (when a "END:NAME" property is reached).

Parameters:

name - the component name (e.g. "VEVENT")

Throws:

ICalRawReader.StopReadingException - to force the reader to stop reading from the data stream

invalidLine

void invalidLine(String line)

Called when a line cannot be parsed.

Parameters:

line - the unparseable line

Throws:

ICalRawReader.StopReadingException - to force the reader to stop reading from the data stream

valuelessParameter

void valuelessParameter(String propertyName,
                        String parameterName)

Called when a value-less parameter is read.

Parameters:

propertyName - the property name (e.g. "VERSION")

parameterName - the parameter name (e.g. "FMTTYPE")