davmail.exchange

Class XMLStreamUtil

java.lang.Object

davmail.exchange.XMLStreamUtil

public final class XMLStreamUtil
extends Object

XmlStreamReader utility methods

Method Summary

Modifier and Type	Method and Description
static XMLStreamReader	createXMLStreamReader(byte[] xmlContent) Create XML stream reader for byte array
static XMLStreamReader	createXMLStreamReader(InputStream inputStream) Create XML stream reader for inputStream
static XMLStreamReader	createXMLStreamReader(String xmlContent) Create XML stream reader for string
static Map<String,Map<String,String>>	getElementContentsAsMap(InputStream inputStream, String rowName, String idName) Convert the XML stream to a map of entries.
static String	getElementText(XMLStreamReader reader) Get element text.
static XMLInputFactory	getXmlInputFactory() Build a new XMLInputFactory.
static boolean	isEndTag(XMLStreamReader reader, String tagLocalName) Test if reader is on an end tag named tagLocalName.
static boolean	isStartTag(XMLStreamReader reader) Test if reader is on a start tag.
static boolean	isStartTag(XMLStreamReader reader, String tagLocalName) Test if reader is on a start tag named tagLocalName.

Methods inherited from class java.lang.Object

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

Method Detail

getXmlInputFactory

public static XMLInputFactory getXmlInputFactory()

Build a new XMLInputFactory.

Returns:

XML input factory

getElementContentsAsMap

public static Map<String,Map<String,String>> getElementContentsAsMap(InputStream inputStream,
                                                                     String rowName,
                                                                     String idName)
                                                              throws IOException

Convert the XML stream to a map of entries. An entry is also a key/value map

Parameters:

inputStream - xml input stream

rowName - xml tag name of entries

idName - xml tag name of entry attribute used as key in the main map

Returns:

map of entries

Throws:

IOException - on error

isStartTag

public static boolean isStartTag(XMLStreamReader reader,
                                 String tagLocalName)

Test if reader is on a start tag named tagLocalName.

Parameters:

reader - xml stream reader

tagLocalName - tag local name

Returns:

true if reader is on a start tag named tagLocalName

isStartTag

public static boolean isStartTag(XMLStreamReader reader)

Test if reader is on a start tag.

Parameters:

reader - xml stream reader

Returns:

true if reader is on a start tag

isEndTag

public static boolean isEndTag(XMLStreamReader reader,
                               String tagLocalName)

Test if reader is on an end tag named tagLocalName.

Parameters:

reader - xml stream reader

tagLocalName - tag local name

Returns:

true if reader is on an end tag named tagLocalName

createXMLStreamReader

public static XMLStreamReader createXMLStreamReader(byte[] xmlContent)
                                             throws XMLStreamException

Create XML stream reader for byte array

Parameters:

xmlContent - xml content as byte array

Returns:

XML stream reader

Throws:

XMLStreamException - on error

createXMLStreamReader

public static XMLStreamReader createXMLStreamReader(String xmlContent)
                                             throws XMLStreamException

Create XML stream reader for string

Parameters:

xmlContent - xml content as string

Returns:

XML stream reader

Throws:

XMLStreamException - on error

createXMLStreamReader

public static XMLStreamReader createXMLStreamReader(InputStream inputStream)
                                             throws XMLStreamException

Create XML stream reader for inputStream

Parameters:

inputStream - xml content inputStream

Returns:

XML stream reader

Throws:

XMLStreamException - on error

getElementText

public static String getElementText(XMLStreamReader reader)

Get element text.

Parameters:

reader - stream reader

Returns:

element text