ezvcard.io.chain

Class ChainingXmlMemoryParser

java.lang.Object

ezvcard.io.chain.ChainingXmlParser<ChainingXmlMemoryParser>

ezvcard.io.chain.ChainingXmlMemoryParser

public class ChainingXmlMemoryParser
extends ChainingXmlParser<ChainingXmlMemoryParser>

Chainer class for parsing xCards (XML-encoded vCards) from strings or DOMs.

Author:

Michael Angstadt

See Also:

Ezvcard.parseXml(String), Ezvcard.parseXml(Document)

Constructor Summary

Constructors

Constructor and Description
ChainingXmlMemoryParser(Document dom)
ChainingXmlMemoryParser(String xml)

Method Summary

Modifier and Type	Method and Description
List<VCard>	all() Reads all vCards from the stream.
VCard	first() Reads the first vCard from the stream.
T	register(VCardPropertyScribe<? extends VCardProperty> scribe) Registers a property scribe.
T	warnings(List<List<ParseWarning>> 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

ChainingXmlMemoryParser

public ChainingXmlMemoryParser(String xml)

ChainingXmlMemoryParser

public ChainingXmlMemoryParser(Document dom)

Method Detail

first

public VCard first()

Reads the first vCard from the stream.

Returns:

the vCard or null if there are no vCards

all

public List<VCard> all()

Reads all vCards from the stream.

Returns:

the parsed vCards

register

public T register(VCardPropertyScribe<? extends VCardProperty> scribe)

Registers a property scribe.

Parameters:

scribe - the scribe

Returns:

this

warnings

public T warnings(List<List<ParseWarning>> 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 vCard. Each element in the list is a list of warnings for one parsed vCard. Therefore, the size of this list will be equal to the number of parsed vCards. If a vCard does not have any warnings, then its warning list will be empty.

Returns:

this