org.apache.axiom.util.stax.debug

Class XMLStreamReaderValidator

java.lang.Object

org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

org.apache.axiom.util.stax.debug.XMLStreamReaderValidator

All Implemented Interfaces:

javax.xml.stream.XMLStreamConstants, javax.xml.stream.XMLStreamReader

Direct Known Subclasses:

OMXMLStreamReaderValidator

public class XMLStreamReaderValidator
extends XMLStreamReaderWrapper

There are several places in the code where events are passed from a source to a consumer using XMLStreamReader events. XMLStreamReader (impl)--> consumer of XMLStreamReader events This simple class can be interjected as a filter and used to do some simple validation. Validating the events coming from source (impl) can help find and correct errors when they occur. Otherwise the errors may be caught much further downstream and hard to fix. XMLStreamReader (impl)--> XMLStreamReaderValiator-> consumer of XMLStreamReader events In the initial version, the XMStreamValidator ensures that the start element events match the end element events.

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	IS_ADV_DEBUG_ENABLED
private static org.apache.commons.logging.Log	log
private java.util.Stack	stack
private boolean	throwExceptions

Fields inherited from interface javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Constructor Summary

Constructors

Constructor and Description
XMLStreamReaderValidator(javax.xml.stream.XMLStreamReader delegate, boolean throwExceptions)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getElementText()
protected void	logParserState() Dump the current event of the delegate.
int	next()
int	nextTag()
private void	reportError(java.lang.String message)
private void	trackEvent(int event)

Methods inherited from class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

close, getAttributeCount, getAttributeLocalName, getAttributeName, getAttributeNamespace, getAttributePrefix, getAttributeType, getAttributeValue, getAttributeValue, getCharacterEncodingScheme, getEncoding, getEventType, getLocalName, getLocation, getName, getNamespaceContext, getNamespaceCount, getNamespacePrefix, getNamespaceURI, getNamespaceURI, getNamespaceURI, getParent, getPIData, getPITarget, getPrefix, getProperty, getText, getTextCharacters, getTextCharacters, getTextLength, getTextStart, getVersion, hasName, hasNext, hasText, isAttributeSpecified, isCharacters, isEndElement, isStandalone, isStartElement, isWhiteSpace, require, standaloneSet

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.apache.commons.logging.Log log

IS_ADV_DEBUG_ENABLED

private static boolean IS_ADV_DEBUG_ENABLED

throwExceptions

private boolean throwExceptions

stack

private java.util.Stack stack

Constructor Detail

XMLStreamReaderValidator

public XMLStreamReaderValidator(javax.xml.stream.XMLStreamReader delegate,
                                boolean throwExceptions)

Parameters:

delegate - XMLStreamReader to validate

throwExceptions - (true if exceptions should be thrown when errors are encountered)

Method Detail

next

public int next()
         throws javax.xml.stream.XMLStreamException

Specified by:

next in interface javax.xml.stream.XMLStreamReader

Overrides:

next in class XMLStreamReaderWrapper

Throws:

javax.xml.stream.XMLStreamException

getElementText

public java.lang.String getElementText()
                                throws javax.xml.stream.XMLStreamException

Specified by:

getElementText in interface javax.xml.stream.XMLStreamReader

Overrides:

getElementText in class XMLStreamReaderWrapper

Throws:

javax.xml.stream.XMLStreamException

nextTag

public int nextTag()
            throws javax.xml.stream.XMLStreamException

Specified by:

nextTag in interface javax.xml.stream.XMLStreamReader

Overrides:

nextTag in class XMLStreamReaderWrapper

Throws:

javax.xml.stream.XMLStreamException

trackEvent

private void trackEvent(int event)
                 throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

reportError

private void reportError(java.lang.String message)
                  throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

logParserState

protected void logParserState()

Dump the current event of the delegate.