biweekly.io

Class StreamReader

java.lang.Object

biweekly.io.StreamReader

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ICalReader, JCalReader, XCalReader

public abstract class StreamReader
extends Object
implements Closeable

Parses iCalendar objects from a data stream.

Author:

Michael Angstadt

Field Summary

Fields

Modifier and Type	Field and Description
protected ParseContext	context
protected ScribeIndex	index
protected TimezoneInfo	tzinfo
protected ParseWarnings	warnings

Constructor Summary

Constructors

Constructor and Description
StreamReader()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract ICalendar	_readNext() Reads the next iCalendar object from the data stream.
ScribeIndex	getScribeIndex() Gets the object that manages the component/property scribes.
TimezoneInfo	getTimezoneInfo() Gets the timezone info of the last iCalendar object that was read.
List<String>	getWarnings() Gets the warnings from the last iCalendar object that was read.
List<ICalendar>	readAll() Reads all iCalendar objects from the data stream.
ICalendar	readNext() Reads the next iCalendar object from the data stream.
void	registerScribe(ICalComponentScribe<? extends ICalComponent> scribe) Registers an experimental component scribe.
void	registerScribe(ICalPropertyScribe<? extends ICalProperty> scribe) Registers an experimental property scribe.
void	setScribeIndex(ScribeIndex index) Sets the object that manages the component/property scribes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Field Detail

warnings

protected final ParseWarnings warnings

tzinfo

protected TimezoneInfo tzinfo

index

protected ScribeIndex index

context

protected ParseContext context

Constructor Detail

StreamReader

public StreamReader()

Method Detail

registerScribe

public void registerScribe(ICalPropertyScribe<? extends ICalProperty> scribe)

Registers an experimental property scribe. Can also be used to override the scribe of a standard property (such as DTSTART). Calling this method is the same as calling:

getScribeIndex().register(scribe).

Parameters:

scribe - the scribe to register

registerScribe

public void registerScribe(ICalComponentScribe<? extends ICalComponent> scribe)

Registers an experimental component scribe. Can also be used to override the scribe of a standard component (such as VEVENT). Calling this method is the same as calling:

getScribeIndex().register(scribe).

Parameters:

scribe - the scribe to register

getScribeIndex

public ScribeIndex getScribeIndex()

Gets the object that manages the component/property scribes.

Returns:

the scribe index

setScribeIndex

public void setScribeIndex(ScribeIndex index)

Sets the object that manages the component/property scribes.

Parameters:

index - the scribe index

getWarnings

public List<String> getWarnings()

Gets the warnings from the last iCalendar object that was read. This list is reset every time a new iCalendar object is read.

Returns:

the warnings or empty list if there were no warnings

getTimezoneInfo

public TimezoneInfo getTimezoneInfo()

Gets the timezone info of the last iCalendar object that was read.

Returns:

the timezone info

readAll

public List<ICalendar> readAll()
                        throws IOException

Reads all iCalendar objects from the data stream.

Returns:

the iCalendar objects

Throws:

IOException - if there's a problem reading from the stream

readNext

public ICalendar readNext()
                   throws IOException

Reads the next iCalendar object from the data stream.

Returns:

the next iCalendar object or null if there are no more

Throws:

IOException - if there's a problem reading from the stream

_readNext

protected abstract ICalendar _readNext()
                                throws IOException

Reads the next iCalendar object from the data stream.

Returns:

the next iCalendar object or null if there are no more

Throws:

IOException - if there's a problem reading from the stream