OMContentHandler (OM Aspects API)

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

All Implemented Interfaces:

ContentHandler, DTDHandler, DeclHandler, LexicalHandler

Direct Known Subclasses:

SAXOMBuilder, SAXResultContentHandler
```
public abstract class OMContentHandler
extends Object
implements ContentHandler, LexicalHandler, DeclHandler, DTDHandler
```
For internal use only.

Constructor Summary

Constructors
Constructor and Description

OMContentHandler(boolean expandEntityReferences)

Constructors
Constructor and Description
`OMContentHandler(boolean expandEntityReferences)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`attributeDecl(String eName, String aName, String type, String mode, String value)`
`void`	`characters(char[] ch, int start, int length)`
`void`	`comment(char[] ch, int start, int length)`
`protected abstract void`	`completed(org.apache.axiom.om.OMElement element)`
`protected abstract void`	`createOMComment(org.apache.axiom.om.OMContainer parent, String content)`
`protected abstract void`	`createOMDocType(org.apache.axiom.om.OMContainer parent, String rootName, String publicId, String systemId, String internalSubset)`
`protected abstract org.apache.axiom.om.OMElement`	`createOMElement(org.apache.axiom.om.OMContainer parent, String localName, String namespaceURI, String prefix, String[] namespaces, int namespaceCount)`
`protected abstract void`	`createOMEntityReference(org.apache.axiom.om.OMContainer parent, String name, String replacementText)`
`protected abstract void`	`createOMProcessingInstruction(org.apache.axiom.om.OMContainer parent, String piTarget, String piData)`
`protected abstract void`	`createOMText(org.apache.axiom.om.OMContainer parent, String text, int type)`
`protected abstract void`	`doEndDocument()`
`protected abstract org.apache.axiom.om.OMContainer`	`doStartDocument()`
`void`	`elementDecl(String name, String model)`
`void`	`endCDATA()`
`void`	`endDocument()`
`void`	`endDTD()`
`void`	`endElement(String uri, String localName, String qName)`
`void`	`endEntity(String name)`
`void`	`endPrefixMapping(String prefix)`
`void`	`externalEntityDecl(String name, String publicId, String systemId)`
`void`	`ignorableWhitespace(char[] ch, int start, int length)`
`void`	`internalEntityDecl(String name, String value)`
`void`	`notationDecl(String name, String publicId, String systemId)`
`void`	`processingInstruction(String piTarget, String data)`
`void`	`setDocumentLocator(Locator locator)`
`void`	`skippedEntity(String name)`
`void`	`startCDATA()`
`void`	`startDocument()`
`void`	`startDTD(String name, String publicId, String systemId)`
`void`	`startElement(String namespaceURI, String localName, String qName, Attributes atts)`
`void`	`startEntity(String name)`
`void`	`startPrefixMapping(String prefix, String uri)`
`void`	`unparsedEntityDecl(String name, String publicId, String systemId, String notationName)`

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

Constructor Detail

OMContentHandler

public OMContentHandler(boolean expandEntityReferences)

Method Detail

setDocumentLocator
```
public final void setDocumentLocator(Locator locator)
```
Specified by:

setDocumentLocator in interface ContentHandler

startDocument
```
public final void startDocument()
                         throws SAXException
```
Specified by:

startDocument in interface ContentHandler

Throws:

SAXException

endDocument
```
public final void endDocument()
                       throws SAXException
```
Specified by:

endDocument in interface ContentHandler

Throws:

SAXException

startDTD

public final void startDTD(String name,
            String publicId,
            String systemId)
                    throws SAXException

Specified by:: startDTD in interface LexicalHandler
Throws:: SAXException

elementDecl

public final void elementDecl(String name,
               String model)
                       throws SAXException

Specified by:: elementDecl in interface DeclHandler
Throws:: SAXException

attributeDecl

public final void attributeDecl(String eName,
                 String aName,
                 String type,
                 String mode,
                 String value)
                         throws SAXException

Specified by:: attributeDecl in interface DeclHandler
Throws:: SAXException

externalEntityDecl

public final void externalEntityDecl(String name,
                      String publicId,
                      String systemId)
                              throws SAXException

Specified by:: externalEntityDecl in interface DeclHandler
Throws:: SAXException

internalEntityDecl

public final void internalEntityDecl(String name,
                      String value)
                              throws SAXException

Specified by:: internalEntityDecl in interface DeclHandler
Throws:: SAXException

notationDecl

public final void notationDecl(String name,
                String publicId,
                String systemId)
                        throws SAXException

Specified by:: notationDecl in interface DTDHandler
Throws:: SAXException

unparsedEntityDecl

public final void unparsedEntityDecl(String name,
                      String publicId,
                      String systemId,
                      String notationName)
                              throws SAXException

Specified by:: unparsedEntityDecl in interface DTDHandler
Throws:: SAXException

endDTD
```
public final void endDTD()
                  throws SAXException
```
Specified by:

endDTD in interface LexicalHandler

Throws:

SAXException

startPrefixMapping

public final void startPrefixMapping(String prefix,
                      String uri)
                              throws SAXException

Specified by:: startPrefixMapping in interface ContentHandler
Throws:: SAXException

endPrefixMapping

public final void endPrefixMapping(String prefix)
                            throws SAXException

Specified by:: endPrefixMapping in interface ContentHandler
Throws:: SAXException

startElement

public final void startElement(String namespaceURI,
                String localName,
                String qName,
                Attributes atts)
                        throws SAXException

Specified by:: startElement in interface ContentHandler
Throws:: SAXException

endElement

public final void endElement(String uri,
              String localName,
              String qName)
                      throws SAXException

Specified by:: endElement in interface ContentHandler
Throws:: SAXException

startCDATA
```
public final void startCDATA()
                      throws SAXException
```
Specified by:

startCDATA in interface LexicalHandler

Throws:

SAXException

endCDATA
```
public final void endCDATA()
                    throws SAXException
```
Specified by:

endCDATA in interface LexicalHandler

Throws:

SAXException

characters

public final void characters(char[] ch,
              int start,
              int length)
                      throws SAXException

Specified by:: characters in interface ContentHandler
Throws:: SAXException

ignorableWhitespace

public final void ignorableWhitespace(char[] ch,
                       int start,
                       int length)
                               throws SAXException

Specified by:: ignorableWhitespace in interface ContentHandler
Throws:: SAXException

processingInstruction

public final void processingInstruction(String piTarget,
                         String data)
                                 throws SAXException

Specified by:: processingInstruction in interface ContentHandler
Throws:: SAXException

comment

public final void comment(char[] ch,
           int start,
           int length)
                   throws SAXException

Specified by:: comment in interface LexicalHandler
Throws:: SAXException

skippedEntity

public final void skippedEntity(String name)
                         throws SAXException

Specified by:: skippedEntity in interface ContentHandler
Throws:: SAXException

startEntity

public final void startEntity(String name)
                       throws SAXException

Specified by:: startEntity in interface LexicalHandler
Throws:: SAXException

endEntity

public final void endEntity(String name)
                     throws SAXException

Specified by:: endEntity in interface LexicalHandler
Throws:: SAXException

doStartDocument

protected abstract org.apache.axiom.om.OMContainer doStartDocument()

doEndDocument

protected abstract void doEndDocument()

createOMDocType

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

createOMElement

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

completed

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

createOMText

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

createOMProcessingInstruction

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

createOMComment

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

createOMEntityReference

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

Class OMContentHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OMContentHandler

Method Detail

setDocumentLocator

startDocument

endDocument

startDTD

elementDecl

attributeDecl

externalEntityDecl

internalEntityDecl

notationDecl

unparsedEntityDecl

endDTD

startPrefixMapping

endPrefixMapping

startElement

endElement

startCDATA

endCDATA

characters

ignorableWhitespace

processingInstruction

comment

skippedEntity

startEntity

endEntity

doStartDocument

doEndDocument

createOMDocType

createOMElement

completed

createOMText

createOMProcessingInstruction

createOMComment

createOMEntityReference