com.revolsys.io.xml

Class StaxUtils

java.lang.Object

com.revolsys.io.xml.StaxUtils

public final class StaxUtils
extends Object

The StaxUtils class provides utility methods for processing XML using the XMLStreamReader class.

Author:

Paul Austin

Method Summary

Methods

Modifier and Type	Method and Description
static void	closeSilent(XMLStreamReader in)
static XMLStreamReader	createXmlReader(InputStream inputStream)
static XMLStreamReader	createXmlReader(Reader reader)
static XMLStreamReader	createXmlReader(org.springframework.core.io.Resource resource)
static String	getAttribute(XMLStreamReader parser, QName typePath)
static boolean	getBooleanAttribute(XMLStreamReader parser, String namespaceUri, String name)
static double	getDoubleAttribute(XMLStreamReader parser, String namespaceUri, String name)
static String	getElementText(XMLStreamReader parser)
static double	getElementTextDouble(XMLStreamReader in, double defaultValue)
static int	getElementTextInt(XMLStreamReader in, int defaultValue)
static int	getIntAttribute(XMLStreamReader parser, String namespaceUri, String name)
static long	getLongAttribute(XMLStreamReader parser, String namespaceUri, String name)
static QName	getQNameAttribute(XMLStreamReader in, QName fieldName)
static QName	getXmlQName(NamespaceContext context, String value)
static boolean	isEndElementLocalName(XMLStreamReader parser, QName name)
static boolean	matchElementLocalName(XMLStreamReader parser, QName element) Check that the parser is currently at the specified XML element.
static int	next(XMLStreamReader parser)
static int	nextTag(XMLStreamReader parser)
static void	require(XMLStreamReader parser, int type, String namespaceURI, String localPart)
static void	require(XMLStreamReader parser, QName element) Check that the parser is currently at the specified XML element.
static void	requireLocalName(XMLStreamReader parser, QName element) Check that the parser is currently at the specified XML element.
static void	requireLocalPart(XMLStreamReader parser, QName element) Check that the parser is currently at the specified XML element.
static void	skipSubTree(XMLStreamReader parser) Skip all elements and content until the end of the current element.
static boolean	skipToChildStartElements(XMLStreamReader parser, Collection<QName> elementNames) Skip all events until the next start element which is a child of the current element has one of the elementNames.
static boolean	skipToChildStartElements(XMLStreamReader parser, QName... elementNames) Skip all events until the next start element which is a child of the current element has one of the elementNames.
static int	skipToEndElement(XMLStreamReader parser) Skip all events until the next end element event.
static void	skipToEndElement(XMLStreamReader parser, QName name) Skip all events until the next end element event.
static void	skipToEndElementByLocalName(XMLStreamReader parser, QName name) Skip all events until the next end element event.
static int	skipToStartElement(XMLStreamReader parser) Skip all events until the next start element event.
static boolean	skipToStartElement(XMLStreamReader parser, String localName)
static boolean	skipToStartElements(XMLStreamReader parser, Collection<QName> elementNames) Skip all events until the next start element event which is for an element with one of the elementNames.
static boolean	skipToStartElements(XMLStreamReader parser, QName... elementNames)
static void	skipToStartOrEndElement(XMLStreamReader parser)
static int	skipWhitespace(XMLStreamReader parser) Skip any whitespace until an start or end of element is found.
static void	startElement(XMLStreamWriter writer, QName element)
static String	toString(XMLStreamReader in)

Methods inherited from class java.lang.Object

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

Method Detail

closeSilent

public static void closeSilent(XMLStreamReader in)

createXmlReader

public static XMLStreamReader createXmlReader(InputStream inputStream)

createXmlReader

public static XMLStreamReader createXmlReader(Reader reader)

createXmlReader

public static XMLStreamReader createXmlReader(org.springframework.core.io.Resource resource)

getAttribute

public static String getAttribute(XMLStreamReader parser,
                  QName typePath)

getBooleanAttribute

public static boolean getBooleanAttribute(XMLStreamReader parser,
                          String namespaceUri,
                          String name)

getDoubleAttribute

public static double getDoubleAttribute(XMLStreamReader parser,
                        String namespaceUri,
                        String name)

getElementText

public static String getElementText(XMLStreamReader parser)

getElementTextDouble

public static double getElementTextDouble(XMLStreamReader in,
                          double defaultValue)

getElementTextInt

public static int getElementTextInt(XMLStreamReader in,
                    int defaultValue)

getIntAttribute

public static int getIntAttribute(XMLStreamReader parser,
                  String namespaceUri,
                  String name)

getLongAttribute

public static long getLongAttribute(XMLStreamReader parser,
                    String namespaceUri,
                    String name)

getQNameAttribute

public static QName getQNameAttribute(XMLStreamReader in,
                      QName fieldName)

getXmlQName

public static QName getXmlQName(NamespaceContext context,
                String value)

isEndElementLocalName

public static boolean isEndElementLocalName(XMLStreamReader parser,
                            QName name)

matchElementLocalName

public static boolean matchElementLocalName(XMLStreamReader parser,
                            QName element)

Check that the parser is currently at the specified XML element.

Parameters:

parser - The STAX XML parser.

element - The expected XML element.

Throws:

XMLStreamException - If an exception processing the XML occurs.

next

public static int next(XMLStreamReader parser)

nextTag

public static int nextTag(XMLStreamReader parser)

require

public static void require(XMLStreamReader parser,
           int type,
           String namespaceURI,
           String localPart)

require

public static void require(XMLStreamReader parser,
           QName element)

Check that the parser is currently at the specified XML element.

Parameters:

parser - The STAX XML parser.

element - The expected XML element.

Throws:

XMLStreamException - If an exception processing the XML occurs.

requireLocalName

public static void requireLocalName(XMLStreamReader parser,
                    QName element)

Check that the parser is currently at the specified XML element.

Parameters:

parser - The STAX XML parser.

element - The expected XML element.

Throws:

XMLStreamException - If an exception processing the XML occurs.

requireLocalPart

public static void requireLocalPart(XMLStreamReader parser,
                    QName element)

Check that the parser is currently at the specified XML element.

Parameters:

parser - The STAX XML parser.

element - The expected XML element.

Throws:

XMLStreamException - If an exception processing the XML occurs.

skipSubTree

public static void skipSubTree(XMLStreamReader parser)

Skip all elements and content until the end of the current element.

Parameters:

parser - The STAX XML parser.

Throws:

XMLStreamException - If an exception processing the XML occurs.

skipToChildStartElements

public static boolean skipToChildStartElements(XMLStreamReader parser,
                               Collection<QName> elementNames)

Skip all events until the next start element which is a child of the current element has one of the elementNames.

Parameters:

parser - The STAX XML parser.

elementNames - The names of the elements to find

Returns:

True if one of the elements was found.

Throws:

XMLStreamException - If an exception processing the XML occurs.

skipToChildStartElements

public static boolean skipToChildStartElements(XMLStreamReader parser,
                               QName... elementNames)

Skip all events until the next start element which is a child of the current element has one of the elementNames.

Parameters:

parser - The STAX XML parser.

elementNames - The names of the elements to find

Returns:

True if one of the elements was found.

Throws:

XMLStreamException - If an exception processing the XML occurs.

skipToEndElement

public static int skipToEndElement(XMLStreamReader parser)

Skip all events until the next end element event.

Parameters:

parser - The STAX XML parser.

Throws:

XMLStreamException - If an exception processing the XML occurs.

skipToEndElement

public static void skipToEndElement(XMLStreamReader parser,
                    QName name)

Skip all events until the next end element event.

Parameters:

parser - The STAX XML parser.

Throws:

XMLStreamException - If an exception processing the XML occurs.

skipToEndElementByLocalName

public static void skipToEndElementByLocalName(XMLStreamReader parser,
                               QName name)

Skip all events until the next end element event.

Parameters:

parser - The STAX XML parser.

Throws:

XMLStreamException - If an exception processing the XML occurs.

skipToStartElement

public static int skipToStartElement(XMLStreamReader parser)

Skip all events until the next start element event.

Parameters:

parser - The STAX XML parser.

Throws:

XMLStreamException - If an exception processing the XML occurs.

skipToStartElement

public static boolean skipToStartElement(XMLStreamReader parser,
                         String localName)

skipToStartElements

public static boolean skipToStartElements(XMLStreamReader parser,
                          Collection<QName> elementNames)

Skip all events until the next start element event which is for an element with one of the elementNames.

Parameters:

parser - The STAX XML parser.

elementNames - The names of the elements to find

Returns:

The name of the matching element, null if end of document is reached.

Throws:

XMLStreamException - If an exception processing the XML occurs.

skipToStartElements

public static boolean skipToStartElements(XMLStreamReader parser,
                          QName... elementNames)

skipToStartOrEndElement

public static void skipToStartOrEndElement(XMLStreamReader parser)

skipWhitespace

public static int skipWhitespace(XMLStreamReader parser)

Skip any whitespace until an start or end of element is found.

Parameters:

parser - The STAX XML parser.

Throws:

XMLStreamException - If an exception processing the XML occurs.

startElement

public static void startElement(XMLStreamWriter writer,
                QName element)

toString

public static String toString(XMLStreamReader in)