org.apache.axis2.om
Interface OMXMLParserWrapper

All Known Implementing Classes:

StAXBuilder

public interface OMXMLParserWrapper

Interface OMXMLParserWrapper

Method Summary

void	discard(OMElement el) Discard the current element This should remove the given element and its decendants.
short	getBuilderType() Returns the type of the builder.
OMElement	getDocumentElement()
java.lang.Object	getParser() Allows to access the underlying parser.
java.lang.Object	getRegisteredContentHandler() get the registered external content handler
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

public int next()
         throws OMException

Proceed the parser one step and return the event value

Returns:

Throws:

OMException

OMException

discard

public void discard(OMElement el)
             throws OMException

Discard the current element This should remove the given element and its decendants.

Parameters:

el -

Throws:

OMException

OMException

setCache

public void setCache(boolean b)
              throws OMException

Parameters:

b -

Throws:

OMException

OMException

getParser

public 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:

isCompleted

public boolean isCompleted()

Returns:

the complete status

getDocumentElement

public OMElement getDocumentElement()

Returns:

the document element

getBuilderType

public short getBuilderType()

Returns the type of the builder. Can be either the PUSH_TYPE_BUILDER or PULL_TYPE_BUILDER

Returns:

registerExternalContentHandler

public void registerExternalContentHandler(java.lang.Object obj)

Registers an external content handler. Especially useful for push type builders. will throw an unsupportedOperationExcveption if such handler registration is not supported

Parameters:

obj -

getRegisteredContentHandler

public java.lang.Object getRegisteredContentHandler()

get the registered external content handler

Returns: