org.jabber.jabberbeans.sax.Extension
Class HashExtensionHandler

java.lang.Object
  |
  +--org.jabber.jabberbeans.sax.SubHandler
        |
        +--org.jabber.jabberbeans.sax.Extension.HashExtensionHandler

Direct Known Subclasses:

IQRegisterHandler, IQSearchRequestHandler, SearchResultHandler

public class HashExtensionHandler

extends SubHandler

Generic handler class for certain types of extensions which are in an data format. These have no formal definition (or at least, no enforced definition) of the item names.

Version:

$Revision: 1.1.1.1 $

Author:

David Waite <dwaite@jabber.com>, $Author: lucky $

Field Summary

(package private) HashExtensionBuilder	builder builder to construct the product extension object
(package private) java.lang.StringBuffer	elementChars StringBuffer holding data between elements

Fields inherited from class org.jabber.jabberbeans.sax.SubHandler

handlerFactory, parent, parser, subCount

Constructor Summary

HashExtensionHandler()
Creates a new HashExtensionHandler instance.

Method Summary

void	characters(char[] ch, int start, int length) This is an exact copy of the characters function in the main handler
protected void	handleEndElement(java.lang.String name) handleEndElement is overloaded by the new class to provide logic to handle element code.
protected void	handleStartElement(java.lang.String name, AttributeList attributes) handleStartElement is overloaded by the new class to provide logic to handle the element code.
protected void	receiveChildData(SubHandler subHandler, java.lang.Object o) receiveChildData is called when a child handler exits, returning control to this code.
protected void	startHandler(java.lang.String name, AttributeList attributes) Gets called when the underlying engine decides to pass an entity and all sub-entities off to your subhandler.
protected java.lang.Object	stopHandler(java.lang.String name) Stophandler is the same as end element, except that it is called saying that the subhandler is no longer in scope.

Methods inherited from class org.jabber.jabberbeans.sax.SubHandler

endDocument, endElement, getHandlerFactory, getSubCount, graftParent, graftSubHandler, ignorableWhitespace, processingInstruction, setChildSubHandler, setDocumentLocator, setHandlerFactory, setParent, setParser, startDocument, startElement

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Field Detail

elementChars

java.lang.StringBuffer elementChars

StringBuffer holding data between elements

builder

HashExtensionBuilder builder

builder to construct the product extension object

Constructor Detail

HashExtensionHandler

public HashExtensionHandler()

Creates a new HashExtensionHandler instance.

Method Detail

characters

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

This is an exact copy of the characters function in the main handler

Overrides:

characters in class SubHandler

Parameters:

ch - character string detected

start - start position

length - length of string

Throws:

SAXException - thrown on error

startHandler

protected final void startHandler(java.lang.String name,
                                  AttributeList attributes)
                           throws SAXException

Gets called when the underlying engine decides to pass an entity and all sub-entities off to your subhandler.

Upon seeing the element that this subhandler handles, we call this constructor, passing in the attributes.

Overrides:

startHandler in class SubHandler

Parameters:

name - name of the element which we are handling.

attributes - list of attributes on this element

handleStartElement

protected final void handleStartElement(java.lang.String name,
                                        AttributeList attributes)
                                 throws SAXException

handleStartElement is overloaded by the new class to provide logic to handle the element code.

Overrides:

handleStartElement in class SubHandler

Parameters:

name - a String value

attributes - an AttributeList value

Throws:

SAXException - if an error occurs

handleEndElement

protected final void handleEndElement(java.lang.String name)
                               throws SAXException

handleEndElement is overloaded by the new class to provide logic to handle element code.

Overrides:

handleEndElement in class SubHandler

Parameters:

name - a String value

Throws:

SAXException - if an error occurs

stopHandler

protected final java.lang.Object stopHandler(java.lang.String name)
                                      throws SAXException

Stophandler is the same as end element, except that it is called saying that the subhandler is no longer in scope.

Overrides:

stopHandler in class SubHandler

Parameters:

Object - a value being returned to the parent - the parent is meant to interpret this result.

receiveChildData

protected void receiveChildData(SubHandler subHandler,
                                java.lang.Object o)

receiveChildData is called when a child handler exits, returning control to this code. The now-defunct handler along with the data object are both returned.

Overrides:

receiveChildData in class SubHandler

Parameters:

subHandler - a SubHandler value

o - an Object value