org.apache.axiom.om
Interface OMXMLParserWrapper

All Known Implementing Classes:
MTOMStAXSOAPModelBuilder, StAXBuilder, StAXOMBuilder, StAXSOAPModelBuilder, XOPAwareStAXOMBuilder

public interface OMXMLParserWrapper

Interface OMXMLParserWrapper


Method Summary
 void discard(OMElement el)
          Discards the current element.
 short getBuilderType()
          Returns the type of the builder.
 java.lang.String getCharacterEncoding()
          Returns the encoding style of the XML data
 OMElement getDocumentElement()
           
 java.lang.Object getParser()
          Allows to access the underlying parser.
 java.lang.Object getRegisteredContentHandler()
          get the registered external content handler
 boolean isCache()
           
 boolean isCompleted()
           
 int next()
          Proceed the parser one step and return the event value.
 void registerExternalContentHandler(java.lang.Object obj)
          Registers an external content handler.
 void setCache(boolean b)
           
 

Method Detail

next

int next()
         throws OMException
Proceed the parser one step and return the event value.

Returns:
Returns int.
Throws:
OMException
OMException

discard

void discard(OMElement el)
             throws OMException
Discards the current element. This will remove the given element and its decendants.

Parameters:
el -
Throws:
OMException
OMException

setCache

void setCache(boolean b)
              throws OMException
Parameters:
b -
Throws:
OMException
OMException

isCache

boolean isCache()
Returns:
true if caching

getParser

java.lang.Object getParser()
Allows to access the underlying parser. Since the parser depends on the underlying implementation, an Object is returned. However the implementations may have restrictions in letting access to the parser.

Returns:
Returns Object.

isCompleted

boolean isCompleted()
Returns:
Returns the complete status.

getDocumentElement

OMElement getDocumentElement()
Returns:
Returns the document element.

getBuilderType

short getBuilderType()
Returns the type of the builder. Can be either PUSH_TYPE_BUILDER or PULL_TYPE_BUILDER.

Returns:
Returns short.

registerExternalContentHandler

void registerExternalContentHandler(java.lang.Object obj)
Registers an external content handler. Especially useful for push type builders. Throws an unsupportedOperationException if such handler registration is not supported.

Parameters:
obj -

getRegisteredContentHandler

java.lang.Object getRegisteredContentHandler()
get the registered external content handler

Returns:
Returns Object.

getCharacterEncoding

java.lang.String getCharacterEncoding()
Returns the encoding style of the XML data

Returns:
the character encoding, defaults to "UTF-8"