biweekly.io.chain

Class ChainingXmlParser<T extends ChainingXmlParser<?>>

java.lang.Object

biweekly.io.chain.ChainingXmlParser<T>

Direct Known Subclasses:

ChainingXmlMemoryParser

public class ChainingXmlParser<T extends ChainingXmlParser<?>>
extends Object

Chainer class for parsing xCals (XML-encoded iCalendar objects).

Author:

Michael Angstadt

See Also:

Biweekly.parseXml(InputStream), Biweekly.parseXml(File), Biweekly.parseXml(Reader)

Constructor Summary

Constructors

Constructor and Description
ChainingXmlParser(Document dom)
ChainingXmlParser(File file)
ChainingXmlParser(InputStream in)
ChainingXmlParser(Reader reader)
ChainingXmlParser(String string)

Method Summary

Methods

Modifier and Type	Method and Description
List<ICalendar>	all() Reads all iCalendar objects from the stream.
ICalendar	first() Reads the first iCalendar object from the stream.
T	register(ICalComponentScribe<? extends ICalComponent> scribe) Registers a component scribe.
T	register(ICalPropertyScribe<? extends ICalProperty> scribe) Registers a property scribe.
T	warnings(List<List<String>> warnings) Provides a list object that any parser warnings will be put into.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChainingXmlParser

public ChainingXmlParser(String string)

ChainingXmlParser

public ChainingXmlParser(InputStream in)

ChainingXmlParser

public ChainingXmlParser(File file)

ChainingXmlParser

public ChainingXmlParser(Reader reader)

ChainingXmlParser

public ChainingXmlParser(Document dom)

Method Detail

register

public T register(ICalPropertyScribe<? extends ICalProperty> scribe)

Registers a property scribe.

Parameters:

scribe - the scribe

Returns:

this

register

public T register(ICalComponentScribe<? extends ICalComponent> scribe)

Registers a component scribe.

Parameters:

scribe - the scribe

Returns:

this

warnings

public T warnings(List<List<String>> warnings)

Provides a list object that any parser warnings will be put into.

Parameters:

warnings - the list object that will be populated with the warnings of each parsed iCalendar object. Each element in the list is a list of warnings for one parsed object. Therefore, the size of this list will be equal to the number of parsed iCalendar objects. If an iCalendar object does not have any warnings, then its warning list will be empty.

Returns:

this

first

public ICalendar first()
                throws IOException

Reads the first iCalendar object from the stream.

Returns:

the iCalendar object or null if there are none

Throws:

IOException - if there's an I/O problem

all

public List<ICalendar> all()
                    throws IOException

Reads all iCalendar objects from the stream.

Returns:

the parsed iCalendar objects

Throws:

IOException - if there's an I/O problem