XmlUtils.CachingContentHandler (Metawidget API Documentation)

java.lang.Object
- org.xml.sax.helpers.DefaultHandler
- - org.metawidget.util.XmlUtils.CachingContentHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

Enclosing class:

XmlUtils
```
public static class XmlUtils.CachingContentHandler
extends org.xml.sax.helpers.DefaultHandler
```
Allows clients to cache SAX events directly rather than, say, caching an XML String and then instantiating a new SAX Parser each time to parse it.
CachingContentHandler operates in two modes. In the first mode it is constructed and passed a delegate ContentHandler. It then proceeds to route all SAX events to the delegate as normal, recording them as it does so. Following endDocument, it sets the delegate to null.
In the second mode, clients can call replay to replay the recorded SAX events on a new ContentHandler.

Constructor Summary

Constructors
Constructor and Description

XmlUtils.CachingContentHandler(ContentHandler delegate)

Constructors
Constructor and Description
`XmlUtils.CachingContentHandler(ContentHandler delegate)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`characters(char[] characters, int start, int length)`
`void`	`endDocument()`
`void`	`endElement(String uri, String localName, String name)`
`void`	`endPrefixMapping(String prefix)`
`void`	`ignorableWhitespace(char[] characters, int start, int length)`
`boolean`	`isPaused()`
`void`	`pause(boolean includeLastEvent)`
`void`	`processingInstruction(String target, String data)`
`void`	`releaseDelegate()` The ContentHandler delegate passed to `CachingContentHandler`'s constructor must be released in order to prevent memory leaks.
`void`	`replay(ContentHandler replayTo)` Replay the cached events.
`void`	`setDocumentLocator(Locator locator)`
`void`	`skippedEntity(String name)`
`void`	`startDocument()`
`void`	`startElement(String uri, String localName, String name, Attributes attributes)`
`void`	`startPrefixMapping(String prefix, String uri)`
`void`	`unpause(boolean includeLastEvent)`

Methods inherited from class org.xml.sax.helpers.DefaultHandler
error, fatalError, notationDecl, resolveEntity, unparsedEntityDecl, warning

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

- Constructor Detail
  - XmlUtils.CachingContentHandler
```
public XmlUtils.CachingContentHandler(ContentHandler delegate)
```
    Parameters:
    delegate - the delegate to route all SAX events to, recording as we go
- Method Detail
  - isPaused
```
public boolean isPaused()
```
  - pause
```
public void pause(boolean includeLastEvent)
```
    Parameters:
    includeLastEvent - whether to include the most recent SAX event in the cache (ie. the one that led us to call pause)
  - unpause
```
public void unpause(boolean includeLastEvent)
```
    Parameters:
    includeLastEvent - whether to include the most recent SAX event in the cache (ie. the one that led us to call unpause)
  - replay
```
public void replay(ContentHandler replayTo)
            throws SAXException
```
    Replay the cached events.
    Note: replay does not necessarily trigger startDocument and endDocument (ie. it does not assume the original recording contained them). Because of this, CachingContentHandler can be used to cache fragments of SAX events.
    
    Throws:
    
    SAXException
  - releaseDelegate
```
public void releaseDelegate()
```
    The ContentHandler delegate passed to CachingContentHandler's constructor must be released in order to prevent memory leaks. This is done automatically by endDocument. But for use cases where endDocument is not triggered, clients can call releaseDelegate to release the delegate manually.
  - startDocument
```
public void startDocument()
                   throws SAXException
```
    Specified by:
    
    startDocument in interface ContentHandler
    
    Overrides:
    
    startDocument in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - processingInstruction
```
public void processingInstruction(String target,
                         String data)
                           throws SAXException
```
    Specified by:
    
    processingInstruction in interface ContentHandler
    
    Overrides:
    
    processingInstruction in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - setDocumentLocator
```
public void setDocumentLocator(Locator locator)
```
    Specified by:
    
    setDocumentLocator in interface ContentHandler
    
    Overrides:
    
    setDocumentLocator in class org.xml.sax.helpers.DefaultHandler
  - skippedEntity
```
public void skippedEntity(String name)
                   throws SAXException
```
    Specified by:
    
    skippedEntity in interface ContentHandler
    
    Overrides:
    
    skippedEntity in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - startPrefixMapping
```
public void startPrefixMapping(String prefix,
                      String uri)
                        throws SAXException
```
    Specified by:
    
    startPrefixMapping in interface ContentHandler
    
    Overrides:
    
    startPrefixMapping in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - endPrefixMapping
```
public void endPrefixMapping(String prefix)
                      throws SAXException
```
    Specified by:
    
    endPrefixMapping in interface ContentHandler
    
    Overrides:
    
    endPrefixMapping in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - startElement
```
public void startElement(String uri,
                String localName,
                String name,
                Attributes attributes)
                  throws SAXException
```
    Specified by:
    
    startElement in interface ContentHandler
    
    Overrides:
    
    startElement in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - characters
```
public void characters(char[] characters,
              int start,
              int length)
                throws SAXException
```
    Specified by:
    
    characters in interface ContentHandler
    
    Overrides:
    
    characters in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - ignorableWhitespace
```
public void ignorableWhitespace(char[] characters,
                       int start,
                       int length)
                         throws SAXException
```
    Specified by:
    
    ignorableWhitespace in interface ContentHandler
    
    Overrides:
    
    ignorableWhitespace in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - endElement
```
public void endElement(String uri,
              String localName,
              String name)
                throws SAXException
```
    Specified by:
    
    endElement in interface ContentHandler
    
    Overrides:
    
    endElement in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException
  - endDocument
```
public void endDocument()
                 throws SAXException
```
    Specified by:
    
    endDocument in interface ContentHandler
    
    Overrides:
    
    endDocument in class org.xml.sax.helpers.DefaultHandler
    
    Throws:
    
    SAXException

Class XmlUtils.CachingContentHandler

Constructor Summary

Method Summary

Methods inherited from class org.xml.sax.helpers.DefaultHandler

Methods inherited from class java.lang.Object

Constructor Detail

XmlUtils.CachingContentHandler

Method Detail

isPaused

pause

unpause

replay

releaseDelegate

startDocument

processingInstruction

setDocumentLocator

skippedEntity

startPrefixMapping

endPrefixMapping

startElement

characters

ignorableWhitespace

endElement

endDocument