ezvcard
Class Ezvcard.ParserChainXmlString

java.lang.Object
  ezvcard.Ezvcard.ParserChainXmlString

Enclosing class:

Ezvcard

public static class Ezvcard.ParserChainXmlString
extends Object

Chainer class for parsing XML vCards.

See Also:

Ezvcard.parseXml(String)

Method Summary

List<VCard>	all() Reads all vCards from the stream.
VCard	first() Reads the first vCard from the stream.
Ezvcard.ParserChainXmlString	register(VCardPropertyScribe<? extends VCardProperty> scribe) Registers a property scribe.
Ezvcard.ParserChainXmlString	warnings(List<List<String>> warnings) Provides a list object that any unmarshal warnings will be put into.

Methods inherited from class java.lang.Object

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

Method Detail

register

public Ezvcard.ParserChainXmlString register(VCardPropertyScribe<? extends VCardProperty> scribe)

Registers a property scribe.

Parameters:

scribe - the scribe

Returns:

this

warnings

public Ezvcard.ParserChainXmlString warnings(List<List<String>> warnings)

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

Parameters:

warnings - the list object that will be populated with the warnings of each unmarshalled vCard. Each element of the list is the list of warnings for one of the unmarshalled vCards. 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

first

public VCard first()
            throws SAXException

Reads the first vCard from the stream.

Returns:

the vCard or null if there are no vCards

Throws:

SAXException - if there's a problem parsing the XML

all

public List<VCard> all()
                throws SAXException

Reads all vCards from the stream.

Returns:

the parsed vCards

Throws:

SAXException - if there's a problem parsing the XML