Package org.biojava.utils.stax

Class CharElementHandlerBase

java.lang.Object

org.biojava.utils.stax.StAXContentHandlerBase

org.biojava.utils.stax.CharElementHandlerBase

All Implemented Interfaces:

StAXContentHandler

public abstract class CharElementHandlerBase
extends StAXContentHandlerBase

StAX handler for any element which just contains a string representation of a char.

This calss collects the string data, and when it is complete, passes it to the (abstract) setCharValue method. Typical use of this class is as a base for a small (often anonymous) class which takes the char value and stores it in some variable.

Since:

1.2

Author:

Matthew Pocock

Constructor Summary

Constructors

Constructor	Description
CharElementHandlerBase()

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int end)	Signal a span of character data in the XML input.
void	endElement(String nsURI, String localName, String qName, StAXContentHandler handler)
protected abstract void	setCharValue(char val)	Override this method to do something useful with the char we collect.
void	startElement(String nsURI, String localName, String qName, Attributes attrs, DelegationManager dm)

Methods inherited from class org.biojava.utils.stax.StAXContentHandlerBase

endPrefixMapping, endTree, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startPrefixMapping, startTree

Methods inherited from class java.lang.Object

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

Constructor Detail

CharElementHandlerBase

public CharElementHandlerBase()

Method Detail

startElement

public void startElement(String nsURI,
                         String localName,
                         String qName,
                         Attributes attrs,
                         DelegationManager dm)
                  throws SAXException

Specified by:

startElement in interface StAXContentHandler

Overrides:

startElement in class StAXContentHandlerBase

Throws:

SAXException

endElement

public void endElement(String nsURI,
                       String localName,
                       String qName,
                       StAXContentHandler handler)
                throws SAXException

Specified by:

endElement in interface StAXContentHandler

Overrides:

endElement in class StAXContentHandlerBase

Throws:

SAXException

characters

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

Description copied from class: StAXContentHandlerBase

Signal a span of character data in the XML input.

Specified by:

characters in interface StAXContentHandler

Overrides:

characters in class StAXContentHandlerBase

Parameters:

ch - an array of characters

start - index of the first significant character for this event.

end - number of characters significant to this event.

Throws:

SAXException

setCharValue

protected abstract void setCharValue(char val)
                              throws SAXException

Override this method to do something useful with the char we collect.

This method will be invoked by endElement with the fully parsed char.

Parameters:

val - the fully parsed char

Throws:

SAXException - if for any reason the char is not palatable