SAXOMBuilder (OM Aspects API)

java.lang.Object
- org.apache.axiom.om.impl.common.OMContentHandler
- - org.apache.axiom.om.impl.common.factory.SAXOMBuilder

All Implemented Interfaces:

org.apache.axiom.om.OMXMLParserWrapper, ContentHandler, DTDHandler, DeclHandler, LexicalHandler
```
public class SAXOMBuilder
extends OMContentHandler
implements org.apache.axiom.om.OMXMLParserWrapper
```

Constructor Summary

Constructors
Constructor and Description

SAXOMBuilder(org.apache.axiom.om.OMFactory factory, SAXSource source, boolean expandEntityReferences)

Constructors
Constructor and Description
`SAXOMBuilder(org.apache.axiom.om.OMFactory factory, SAXSource source, boolean expandEntityReferences)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`protected void`	`completed(org.apache.axiom.om.OMElement element)`
`protected void`	`createOMComment(org.apache.axiom.om.OMContainer parent, String content)`
`protected void`	`createOMDocType(org.apache.axiom.om.OMContainer parent, String rootName, String publicId, String systemId, String internalSubset)`
`protected org.apache.axiom.om.OMElement`	`createOMElement(org.apache.axiom.om.OMContainer parent, String localName, String namespaceURI, String prefix, String[] namespaces, int namespaceCount)`
`protected void`	`createOMEntityReference(org.apache.axiom.om.OMContainer parent, String name, String replacementText)`
`protected void`	`createOMProcessingInstruction(org.apache.axiom.om.OMContainer parent, String piTarget, String piData)`
`protected void`	`createOMText(org.apache.axiom.om.OMContainer parent, String text, int type)`
`void`	`detach()`
`void`	`discard(org.apache.axiom.om.OMElement el)`
`protected void`	`doEndDocument()`
`protected org.apache.axiom.om.OMContainer`	`doStartDocument()`
`short`	`getBuilderType()`
`String`	`getCharacterEncoding()`
`org.apache.axiom.om.OMDocument`	`getDocument()`
`org.apache.axiom.om.OMElement`	`getDocumentElement()`
`org.apache.axiom.om.OMElement`	`getDocumentElement(boolean discardDocument)`
`Object`	`getParser()`
`Object`	`getRegisteredContentHandler()`
`boolean`	`isCache()`
`boolean`	`isCompleted()`
`int`	`next()`
`void`	`registerExternalContentHandler(Object obj)`
`void`	`setCache(boolean b)`

Methods inherited from class org.apache.axiom.om.impl.common.OMContentHandler
attributeDecl, characters, comment, elementDecl, endCDATA, endDocument, endDTD, endElement, endEntity, endPrefixMapping, externalEntityDecl, ignorableWhitespace, internalEntityDecl, notationDecl, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDocument, startDTD, startElement, startEntity, startPrefixMapping, unparsedEntityDecl

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SAXOMBuilder

public SAXOMBuilder(org.apache.axiom.om.OMFactory factory,
            SAXSource source,
            boolean expandEntityReferences)

Method Detail

doStartDocument
```
protected org.apache.axiom.om.OMContainer doStartDocument()
```
Specified by:

doStartDocument in class OMContentHandler

doEndDocument
```
protected void doEndDocument()
```
Specified by:

doEndDocument in class OMContentHandler

getDocument
```
public org.apache.axiom.om.OMDocument getDocument()
```
Specified by:

getDocument in interface org.apache.axiom.om.OMXMLParserWrapper

next
```
public int next()
         throws org.apache.axiom.om.OMException
```
Specified by:

next in interface org.apache.axiom.om.OMXMLParserWrapper

Throws:

org.apache.axiom.om.OMException

discard
```
public void discard(org.apache.axiom.om.OMElement el)
             throws org.apache.axiom.om.OMException
```
Specified by:

discard in interface org.apache.axiom.om.OMXMLParserWrapper

Throws:

org.apache.axiom.om.OMException

setCache
```
public void setCache(boolean b)
              throws org.apache.axiom.om.OMException
```
Specified by:

setCache in interface org.apache.axiom.om.OMXMLParserWrapper

Throws:

org.apache.axiom.om.OMException

isCache
```
public boolean isCache()
```
Specified by:

isCache in interface org.apache.axiom.om.OMXMLParserWrapper

getParser
```
public Object getParser()
```
Specified by:

getParser in interface org.apache.axiom.om.OMXMLParserWrapper

isCompleted
```
public boolean isCompleted()
```
Specified by:

isCompleted in interface org.apache.axiom.om.OMXMLParserWrapper

getDocumentElement
```
public org.apache.axiom.om.OMElement getDocumentElement()
```
Specified by:

getDocumentElement in interface org.apache.axiom.om.OMXMLParserWrapper

getDocumentElement
```
public org.apache.axiom.om.OMElement getDocumentElement(boolean discardDocument)
```
Specified by:

getDocumentElement in interface org.apache.axiom.om.OMXMLParserWrapper

getBuilderType
```
public short getBuilderType()
```
Specified by:

getBuilderType in interface org.apache.axiom.om.OMXMLParserWrapper

registerExternalContentHandler
```
public void registerExternalContentHandler(Object obj)
```
Specified by:

registerExternalContentHandler in interface org.apache.axiom.om.OMXMLParserWrapper

getRegisteredContentHandler
```
public Object getRegisteredContentHandler()
```
Specified by:

getRegisteredContentHandler in interface org.apache.axiom.om.OMXMLParserWrapper

getCharacterEncoding
```
public String getCharacterEncoding()
```
Specified by:

getCharacterEncoding in interface org.apache.axiom.om.OMXMLParserWrapper

close
```
public void close()
```
Specified by:

close in interface org.apache.axiom.om.OMXMLParserWrapper

createOMDocType

protected void createOMDocType(org.apache.axiom.om.OMContainer parent,
                   String rootName,
                   String publicId,
                   String systemId,
                   String internalSubset)

Specified by:: createOMDocType in class OMContentHandler

createOMElement

protected org.apache.axiom.om.OMElement createOMElement(org.apache.axiom.om.OMContainer parent,
                                            String localName,
                                            String namespaceURI,
                                            String prefix,
                                            String[] namespaces,
                                            int namespaceCount)

Specified by:: createOMElement in class OMContentHandler

completed

protected void completed(org.apache.axiom.om.OMElement element)

Specified by:: completed in class OMContentHandler

createOMText

protected void createOMText(org.apache.axiom.om.OMContainer parent,
                String text,
                int type)

Specified by:: createOMText in class OMContentHandler

createOMProcessingInstruction

protected void createOMProcessingInstruction(org.apache.axiom.om.OMContainer parent,
                                 String piTarget,
                                 String piData)

Specified by:: createOMProcessingInstruction in class OMContentHandler

createOMComment

protected void createOMComment(org.apache.axiom.om.OMContainer parent,
                   String content)

Specified by:: createOMComment in class OMContentHandler

createOMEntityReference

protected void createOMEntityReference(org.apache.axiom.om.OMContainer parent,
                           String name,
                           String replacementText)

Specified by:: createOMEntityReference in class OMContentHandler

detach
```
public void detach()
```
Specified by:

detach in interface org.apache.axiom.om.OMXMLParserWrapper

Class SAXOMBuilder

Constructor Summary

Method Summary

Methods inherited from class org.apache.axiom.om.impl.common.OMContentHandler

Methods inherited from class java.lang.Object

Constructor Detail

SAXOMBuilder

Method Detail

doStartDocument

doEndDocument

getDocument

next

discard

setCache

isCache

getParser

isCompleted

getDocumentElement

getDocumentElement

getBuilderType

registerExternalContentHandler

getRegisteredContentHandler

getCharacterEncoding

close

createOMDocType

createOMElement

completed

createOMText

createOMProcessingInstruction

createOMComment

createOMEntityReference

detach