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

java.lang.Object
  extended by org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper
      extended by org.apache.axiom.util.stax.debug.XMLStreamReaderValidator
All Implemented Interfaces:
XMLStreamConstants, 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 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
XMLStreamReaderValidator(XMLStreamReader delegate, boolean throwExceptions)
           
 
Method Summary
 String getElementText()
           
protected  void logParserState()
          Dump the current event of the delegate.
 int next()
           
 int nextTag()
           
 
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
 

Constructor Detail

XMLStreamReaderValidator

public XMLStreamReaderValidator(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 XMLStreamException
Specified by:
next in interface XMLStreamReader
Overrides:
next in class XMLStreamReaderWrapper
Throws:
XMLStreamException

getElementText

public String getElementText()
                      throws XMLStreamException
Specified by:
getElementText in interface XMLStreamReader
Overrides:
getElementText in class XMLStreamReaderWrapper
Throws:
XMLStreamException

nextTag

public int nextTag()
            throws XMLStreamException
Specified by:
nextTag in interface XMLStreamReader
Overrides:
nextTag in class XMLStreamReaderWrapper
Throws:
XMLStreamException

logParserState

protected void logParserState()
Dump the current event of the delegate.



Copyright © 2004-2012 The Apache Software Foundation. All Rights Reserved.