org.apache.avalon.framework.configuration

Class SAXConfigurationHandler

Implemented Interfaces:
ErrorHandler

public class SAXConfigurationHandler
extends DefaultHandler
implements ErrorHandler

A SAXConfigurationHandler helps build Configurations out of sax events.
Version:
CVS $Revision: 1.32 $ $Date: 2004/02/11 14:34:26 $
Author:
Avalon Development Team

Method Summary

void
characters(char[] ch, int start, int end)
Handling hook for character data.
void
clear()
Clears all data from this configuration handler.
protected DefaultConfiguration
createConfiguration(String localName, String location)
Create a new DefaultConfiguration with the specified local name and location.
void
endElement(String namespaceURI, String localName, String rawName)
Handling hook for finishing parsing of an element.
void
error(SAXParseException exception)
This just throws an exception on a parse error.
void
fatalError(SAXParseException exception)
This just throws an exception on a parse error.
Configuration
getConfiguration()
Get the configuration object that was built.
protected String
getLocationString()
Returns a string showing the current system ID, line number and column number.
void
setDocumentLocator(Locator locator)
Set the document Locator to use.
void
startElement(String namespaceURI, String localName, String rawName, Attributes attributes)
Handling hook for starting parsing of an element.
void
warning(SAXParseException exception)
This just throws an exception on a parse error.

Method Details

characters

public void characters(char[] ch,
                       int start,
                       int end)
            throws SAXException
Handling hook for character data.
Parameters:
ch - a char[] of data
start - offset in the character array from which to start reading
end - length of character data

clear

public void clear()
Clears all data from this configuration handler.

createConfiguration

protected DefaultConfiguration createConfiguration(String localName,
                                                   String location)
Create a new DefaultConfiguration with the specified local name and location.
Parameters:
localName - a String value
location - a String value
Returns:
a DefaultConfiguration value

endElement

public void endElement(String namespaceURI,
                       String localName,
                       String rawName)
            throws SAXException
Handling hook for finishing parsing of an element.
Parameters:
namespaceURI - a String value
localName - a String value
rawName - a String value

error

public void error(SAXParseException exception)
            throws SAXException
This just throws an exception on a parse error.
Parameters:
exception - the parse error

fatalError

public void fatalError(SAXParseException exception)
            throws SAXException
This just throws an exception on a parse error.
Parameters:
exception - the parse error

getConfiguration

public Configuration getConfiguration()
Get the configuration object that was built.
Returns:
a Configuration object

getLocationString

protected String getLocationString()
Returns a string showing the current system ID, line number and column number.
Returns:
a String value

setDocumentLocator

public void setDocumentLocator(Locator locator)
Set the document Locator to use.
Parameters:
locator - a Locator value

startElement

public void startElement(String namespaceURI,
                         String localName,
                         String rawName,
                         Attributes attributes)
            throws SAXException
Handling hook for starting parsing of an element.
Parameters:
namespaceURI - a String value
localName - a String value
rawName - a String value
attributes - an Attributes value

warning

public void warning(SAXParseException exception)
            throws SAXException
This just throws an exception on a parse error.
Parameters:
exception - the parse error