org.apache.axiom.om.util
Class OMXMLStreamReaderValidator

java.lang.Object
  org.apache.axiom.om.util.OMXMLStreamReaderValidator

All Implemented Interfaces:

javax.xml.stream.XMLStreamConstants, javax.xml.stream.XMLStreamReader, OMAttachmentAccessor, OMXMLStreamReader

public class OMXMLStreamReaderValidator
extends java.lang.Object
implements OMXMLStreamReader

There are several places in the code where events are passed from a source to a consumer using XMLStreamReader events. OMXMLStreamReader (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. OMXMLStreamReader (impl)--> OMXMLStreamReaderValiator-> consumer of XMLStreamReader events In the initial version, the XMStreamValidator ensures that the start element events match the end element events.

See Also:

OMElement.getXMLStreamReader(boolean)

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

OMXMLStreamReaderValidator(OMXMLStreamReader delegate, boolean throwExceptions)

Method Summary

void	close()
int	getAttributeCount()
java.lang.String	getAttributeLocalName(int arg0)
javax.xml.namespace.QName	getAttributeName(int arg0)
java.lang.String	getAttributeNamespace(int arg0)
java.lang.String	getAttributePrefix(int arg0)
java.lang.String	getAttributeType(int arg0)
java.lang.String	getAttributeValue(int arg0)
java.lang.String	getAttributeValue(java.lang.String arg0, java.lang.String arg1)
java.lang.String	getCharacterEncodingScheme()
javax.activation.DataHandler	getDataHandler(java.lang.String blobcid)
java.lang.String	getElementText()
java.lang.String	getEncoding()
int	getEventType()
java.lang.String	getLocalName()
javax.xml.stream.Location	getLocation()
javax.xml.namespace.QName	getName()
javax.xml.namespace.NamespaceContext	getNamespaceContext()
int	getNamespaceCount()
java.lang.String	getNamespacePrefix(int arg0)
java.lang.String	getNamespaceURI()
java.lang.String	getNamespaceURI(int arg0)
java.lang.String	getNamespaceURI(java.lang.String arg0)
java.lang.String	getPIData()
java.lang.String	getPITarget()
java.lang.String	getPrefix()
java.lang.Object	getProperty(java.lang.String arg0)
java.lang.String	getText()
char[]	getTextCharacters()
int	getTextCharacters(int arg0, char[] arg1, int arg2, int arg3)
int	getTextLength()
int	getTextStart()
java.lang.String	getVersion()
boolean	hasName()
boolean	hasNext()
boolean	hasText()
boolean	isAttributeSpecified(int arg0)
boolean	isCharacters()
boolean	isEndElement()
boolean	isInlineMTOM() By default, an OMText item that has an MTOM datahandler will be rendered as a inlined text event.
boolean	isStandalone()
boolean	isStartElement()
boolean	isWhiteSpace()
protected void	logParserState() Dump the current event of the delegate.
int	next()
int	nextTag()
void	require(int arg0, java.lang.String arg1, java.lang.String arg2)
void	setInlineMTOM(boolean value)
boolean	standaloneSet()

Methods inherited from class java.lang.Object

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

Constructor Detail

OMXMLStreamReaderValidator

public OMXMLStreamReaderValidator(OMXMLStreamReader 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

Throws:

javax.xml.stream.XMLStreamException

close

public void close()
           throws javax.xml.stream.XMLStreamException

Specified by:

close in interface javax.xml.stream.XMLStreamReader

Throws:

javax.xml.stream.XMLStreamException

getAttributeCount

public int getAttributeCount()

Specified by:

getAttributeCount in interface javax.xml.stream.XMLStreamReader

getAttributeLocalName

public java.lang.String getAttributeLocalName(int arg0)

Specified by:

getAttributeLocalName in interface javax.xml.stream.XMLStreamReader

getAttributeName

public javax.xml.namespace.QName getAttributeName(int arg0)

Specified by:

getAttributeName in interface javax.xml.stream.XMLStreamReader

getAttributeNamespace

public java.lang.String getAttributeNamespace(int arg0)

Specified by:

getAttributeNamespace in interface javax.xml.stream.XMLStreamReader

getAttributePrefix

public java.lang.String getAttributePrefix(int arg0)

Specified by:

getAttributePrefix in interface javax.xml.stream.XMLStreamReader

getAttributeType

public java.lang.String getAttributeType(int arg0)

Specified by:

getAttributeType in interface javax.xml.stream.XMLStreamReader

getAttributeValue

public java.lang.String getAttributeValue(int arg0)

Specified by:

getAttributeValue in interface javax.xml.stream.XMLStreamReader

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String arg0,
                                          java.lang.String arg1)

Specified by:

getAttributeValue in interface javax.xml.stream.XMLStreamReader

getCharacterEncodingScheme

public java.lang.String getCharacterEncodingScheme()

Specified by:

getCharacterEncodingScheme in interface javax.xml.stream.XMLStreamReader

getElementText

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

Specified by:

getElementText in interface javax.xml.stream.XMLStreamReader

Throws:

javax.xml.stream.XMLStreamException

getEncoding

public java.lang.String getEncoding()

Specified by:

getEncoding in interface javax.xml.stream.XMLStreamReader

getEventType

public int getEventType()

Specified by:

getEventType in interface javax.xml.stream.XMLStreamReader

getLocalName

public java.lang.String getLocalName()

Specified by:

getLocalName in interface javax.xml.stream.XMLStreamReader

getLocation

public javax.xml.stream.Location getLocation()

Specified by:

getLocation in interface javax.xml.stream.XMLStreamReader

getName

public javax.xml.namespace.QName getName()

Specified by:

getName in interface javax.xml.stream.XMLStreamReader

getNamespaceContext

public javax.xml.namespace.NamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface javax.xml.stream.XMLStreamReader

getNamespaceCount

public int getNamespaceCount()

Specified by:

getNamespaceCount in interface javax.xml.stream.XMLStreamReader

getNamespacePrefix

public java.lang.String getNamespacePrefix(int arg0)

Specified by:

getNamespacePrefix in interface javax.xml.stream.XMLStreamReader

getNamespaceURI

public java.lang.String getNamespaceURI()

Specified by:

getNamespaceURI in interface javax.xml.stream.XMLStreamReader

getNamespaceURI

public java.lang.String getNamespaceURI(int arg0)

Specified by:

getNamespaceURI in interface javax.xml.stream.XMLStreamReader

getNamespaceURI

public java.lang.String getNamespaceURI(java.lang.String arg0)

Specified by:

getNamespaceURI in interface javax.xml.stream.XMLStreamReader

getPIData

public java.lang.String getPIData()

Specified by:

getPIData in interface javax.xml.stream.XMLStreamReader

getPITarget

public java.lang.String getPITarget()

Specified by:

getPITarget in interface javax.xml.stream.XMLStreamReader

getPrefix

public java.lang.String getPrefix()

Specified by:

getPrefix in interface javax.xml.stream.XMLStreamReader

getProperty

public java.lang.Object getProperty(java.lang.String arg0)
                             throws java.lang.IllegalArgumentException

Specified by:

getProperty in interface javax.xml.stream.XMLStreamReader

Throws:

java.lang.IllegalArgumentException

getText

public java.lang.String getText()

Specified by:

getText in interface javax.xml.stream.XMLStreamReader

getTextCharacters

public char[] getTextCharacters()

Specified by:

getTextCharacters in interface javax.xml.stream.XMLStreamReader

getTextCharacters

public int getTextCharacters(int arg0,
                             char[] arg1,
                             int arg2,
                             int arg3)
                      throws javax.xml.stream.XMLStreamException

Specified by:

getTextCharacters in interface javax.xml.stream.XMLStreamReader

Throws:

javax.xml.stream.XMLStreamException

getTextLength

public int getTextLength()

Specified by:

getTextLength in interface javax.xml.stream.XMLStreamReader

getTextStart

public int getTextStart()

Specified by:

getTextStart in interface javax.xml.stream.XMLStreamReader

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface javax.xml.stream.XMLStreamReader

hasName

public boolean hasName()

Specified by:

hasName in interface javax.xml.stream.XMLStreamReader

hasNext

public boolean hasNext()
                throws javax.xml.stream.XMLStreamException

Specified by:

hasNext in interface javax.xml.stream.XMLStreamReader

Throws:

javax.xml.stream.XMLStreamException

hasText

public boolean hasText()

Specified by:

hasText in interface javax.xml.stream.XMLStreamReader

isAttributeSpecified

public boolean isAttributeSpecified(int arg0)

Specified by:

isAttributeSpecified in interface javax.xml.stream.XMLStreamReader

isCharacters

public boolean isCharacters()

Specified by:

isCharacters in interface javax.xml.stream.XMLStreamReader

isEndElement

public boolean isEndElement()

Specified by:

isEndElement in interface javax.xml.stream.XMLStreamReader

isStandalone

public boolean isStandalone()

Specified by:

isStandalone in interface javax.xml.stream.XMLStreamReader

isStartElement

public boolean isStartElement()

Specified by:

isStartElement in interface javax.xml.stream.XMLStreamReader

isWhiteSpace

public boolean isWhiteSpace()

Specified by:

isWhiteSpace in interface javax.xml.stream.XMLStreamReader

nextTag

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

Specified by:

nextTag in interface javax.xml.stream.XMLStreamReader

Throws:

javax.xml.stream.XMLStreamException

require

public void require(int arg0,
                    java.lang.String arg1,
                    java.lang.String arg2)
             throws javax.xml.stream.XMLStreamException

Specified by:

require in interface javax.xml.stream.XMLStreamReader

Throws:

javax.xml.stream.XMLStreamException

standaloneSet

public boolean standaloneSet()

Specified by:

standaloneSet in interface javax.xml.stream.XMLStreamReader

logParserState

protected void logParserState()

Dump the current event of the delegate.

getDataHandler

public javax.activation.DataHandler getDataHandler(java.lang.String blobcid)

Specified by:

getDataHandler in interface OMAttachmentAccessor

Parameters:

blobcid - (without the surrounding angle brackets and "cid:" prefix)

Returns:

The DataHandler of the mime part referred by the Content-Id or *null* if the mime part referred by the content-id does not exist

isInlineMTOM

public boolean isInlineMTOM()

Description copied from interface: OMXMLStreamReader

By default, an OMText item that has an MTOM datahandler will be rendered as a inlined text event.

Specified by:

isInlineMTOM in interface OMXMLStreamReader

Returns:

true if inlined as TEXT, false if XOP_INCLUDE is used

setInlineMTOM

public void setInlineMTOM(boolean value)

Specified by:

setInlineMTOM in interface OMXMLStreamReader

Parameters:

value - set to true if inlining of text is desired (default) throw OMException if not the value is not supported.