org.opencrx.application.uses.ezvcard.io.xml

Class XCardReader

java.lang.Object

org.opencrx.application.uses.ezvcard.io.StreamReader

org.opencrx.application.uses.ezvcard.io.xml.XCardReader

All Implemented Interfaces:

Closeable, AutoCloseable

public class XCardReader
extends StreamReader

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

Example:

 File file = new File("vcards.xml");
 List<VCard> vcards = new ArrayList<VCard>();
 XCardReader xcardReader = new XCardReader(file);
 VCard vcard;
 while ((vcard = xcardReader.readNext()) != null) {
        vcards.add(vcard);
 }
 xcardReader.close();
 

Author:

Michael Angstadt

See Also:

RFC 6351

Field Summary

Fields inherited from class org.opencrx.application.uses.ezvcard.io.StreamReader

index, warnings

Constructor Summary

Constructors

Constructor and Description
XCardReader(File file) Creates an xCard reader.
XCardReader(InputStream in) Creates an xCard reader.
XCardReader(Node node) Creates an xCard reader.
XCardReader(Reader reader) Creates an xCard reader.
XCardReader(String xml) Creates an xCard reader.

Method Summary

Methods

Modifier and Type	Method and Description
protected VCard	_readNext() Reads the next vCard from the data stream.
void	close() Closes the underlying input stream.

Methods inherited from class org.opencrx.application.uses.ezvcard.io.StreamReader

assignLabels, getScribeIndex, getWarnings, readAll, readNext, registerScribe, setScribeIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

XCardReader

public XCardReader(String xml)

Creates an xCard reader.

Parameters:

xml - the XML to read the xCards from

XCardReader

public XCardReader(InputStream in)

Creates an xCard reader.

Parameters:

in - the input stream to read the xCards from

XCardReader

public XCardReader(File file)
            throws FileNotFoundException

Creates an xCard reader.

Parameters:

file - the file to read the xCards from

Throws:

FileNotFoundException - if the file doesn't exist

XCardReader

public XCardReader(Reader reader)

Creates an xCard reader.

Parameters:

reader - the reader to read from

XCardReader

public XCardReader(Node node)

Creates an xCard reader.

Parameters:

node - the DOM node to read from

Method Detail

_readNext

protected VCard _readNext()
                   throws IOException

Description copied from class: StreamReader

Reads the next vCard from the data stream.

Specified by:

_readNext in class StreamReader

Returns:

the next vCard or null if there are no more

Throws:

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

close

public void close()
           throws IOException

Closes the underlying input stream.

Throws:

IOException