biweekly.io.xml

Class XCalReader

java.lang.Object

biweekly.io.xml.XCalReader

All Implemented Interfaces:

Closeable, AutoCloseable

public class XCalReader
extends Object
implements Closeable

Reads xCals (XML-encoded vCards) in a streaming fashion.

Example:

 File file = new File("xcals.xml");
 List<ICalendar> icals = new ArrayList<ICalendar>();
 XCalReader xcalReader = new XCalReader(file);
 ICalendar ical;
 while ((ical = xcalReader.readNext()) != null) {
        icals.add(ical);
 }
 

Author:

Michael Angstadt

See Also:

RFC 6321

Constructor Summary

Constructors

Constructor and Description
XCalReader(File file) Creates an xCal reader.
XCalReader(InputStream in) Creates an xCal reader.
XCalReader(Node node) Creates an xCal reader.
XCalReader(Reader reader) Creates an xCal reader.
XCalReader(String str) Creates an xCal reader.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the underlying input stream.
ScribeIndex	getScribeIndex() Gets the scribe index.
List<String>	getWarnings() Gets the warnings from the last iCalendar object that was unmarshalled.
ICalendar	readNext() Reads the next iCalendar object from the xCal stream.
void	registerScribe(ICalComponentScribe<? extends ICalComponent> scribe) Registers a component scribe.
void	registerScribe(ICalPropertyScribe<? extends ICalProperty> scribe) Registers a property scribe.
void	setScribeIndex(ScribeIndex index) Sets the scribe index.

Methods inherited from class java.lang.Object

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

Constructor Detail

XCalReader

public XCalReader(String str)

Creates an xCal reader.

Parameters:

str - the string to read the xCals from

XCalReader

public XCalReader(InputStream in)

Creates an xCal reader.

Parameters:

in - the input stream to read the xCals from

XCalReader

public XCalReader(File file)
           throws FileNotFoundException

Creates an xCal reader.

Parameters:

file - the file to read the xCals from

Throws:

FileNotFoundException - if the file doesn't exist

XCalReader

public XCalReader(Reader reader)

Creates an xCal reader.

Parameters:

reader - the reader to read from

XCalReader

public XCalReader(Node node)

Creates an xCal reader.

Parameters:

node - the DOM node to read from

Method Detail

registerScribe

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

Registers a component scribe. This is the same as calling:

getScribeIndex().register(scribe)

Parameters:

scribe - the scribe to register

registerScribe

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

Registers a property scribe. This is the same as calling:

getScribeIndex().register(scribe)

Parameters:

scribe - the scribe to register

getScribeIndex

public ScribeIndex getScribeIndex()

Gets the scribe index.

Returns:

the scribe index

setScribeIndex

public void setScribeIndex(ScribeIndex index)

Sets the scribe index.

Parameters:

index - the scribe index

getWarnings

public List<String> getWarnings()

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

Returns:

the warnings or empty list if there were no warnings

readNext

public ICalendar readNext()
                   throws TransformerException

Reads the next iCalendar object from the xCal stream.

Returns:

the next iCalendar object or null if there are no more

Throws:

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

close

public void close()
           throws IOException

Closes the underlying input stream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException