biweekly

Class Biweekly.ParserChainXmlReader

java.lang.Object

biweekly.Biweekly.ParserChainXmlReader

Enclosing class:

Biweekly

public static class Biweekly.ParserChainXmlReader
extends Object

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

See Also:

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

Method Summary

Methods

Modifier and Type	Method and Description
List<ICalendar>	all() Reads all iCalendar objects from the data stream.
ICalendar	first() Reads the first iCalendar object from the data stream.
Biweekly.ParserChainXmlReader	register(ICalComponentScribe<? extends ICalComponent> scribe) Registers a component scribe.
Biweekly.ParserChainXmlReader	register(ICalPropertyScribe<? extends ICalProperty> scribe) Registers a property scribe.
Biweekly.ParserChainXmlReader	warnings(List<List<String>> warnings) Provides a list for putting the parser warnings into.

Methods inherited from class java.lang.Object

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

Method Detail

register

public Biweekly.ParserChainXmlReader register(ICalPropertyScribe<? extends ICalProperty> scribe)

Registers a property scribe.

Parameters:

scribe - the scribe

Returns:

this

register

public Biweekly.ParserChainXmlReader register(ICalComponentScribe<? extends ICalComponent> scribe)

Registers a component scribe.

Parameters:

scribe - the scribe

Returns:

this

warnings

public Biweekly.ParserChainXmlReader warnings(List<List<String>> warnings)

Provides a list for putting the parser warnings into.

Parameters:

warnings - the list object to populate (it is a "list of lists"--each parsed ICalendar object has its own warnings list)

Returns:

this

first

public ICalendar first()
                throws IOException,
                       SAXException

Reads the first iCalendar object from the data stream.

Returns:

the first iCalendar object or null if there are none

Throws:

IOException - if there a problem reading from the data stream

SAXException - if there's a problem parsing the XML

all

public List<ICalendar> all()
                    throws IOException,
                           SAXException

Reads all iCalendar objects from the data stream.

Returns:

the parsed iCalendar objects

Throws:

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

SAXException - if there's a problem parsing the XML