Class DelegatingHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.apache.ivy.osgi.util.DelegatingHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class DelegatingHandler
extends DefaultHandler
implements DTDHandler, ContentHandler, ErrorHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DelegatingHandler.ChildElementHandler<DH extends DelegatingHandler>

Constructor Summary

Constructors

Constructor	Description
DelegatingHandler(String name)

Method Summary

Modifier and Type	Method	Description
protected <DH extends DelegatingHandler> void	addChild(DH saxHandler, DelegatingHandler.ChildElementHandler<DH> elementHandler)
final void	characters(char[] ch, int start, int length)
protected void	doCharacters(char[] ch, int start, int length)
protected void	doEndDocument()	By default do nothing.
protected void	doEndElement(String uri, String localName, String name)	By default do nothing.
protected void	doEndPrefixMapping(String prefix)	By default do nothing.
protected void	doError(SAXParseException exception)	By default do nothing.
protected void	doFatalError(SAXParseException exception)	By default do nothing.
protected void	doIgnorableWhitespace(char[] ch, int start, int length)	By default do nothing
protected void	doNotationDecl(String name, String publicId, String systemId)	By default do nothing.
protected void	doProcessingInstruction(String target, String data)	By default do nothing
protected void	doSkippedEntity(String name)	By default do nothing.
protected void	doStartDocument()	By default do nothing.
protected void	doStartElement(String uri, String localName, String name, Attributes atts)	By default do nothing.
protected void	doStartPrefixMapping(String prefix, String uri)	By default do nothing.
protected void	doUnparsedEntityDecl(String name, String publicId, String systemId, String notationName)	By default do nothing.
protected void	doWarning(SAXParseException exception)	By default do nothing.
final void	endDocument()
final void	endElement(String uri, String localName, String n)
final void	endPrefixMapping(String prefix)
final void	error(SAXParseException exception)
final void	fatalError(SAXParseException exception)
String	getBufferedChars()
protected String	getCurrentElementIdentifier()	Return an sort of identifier of the current element being parsed.
protected static String	getLocation(Locator locator)
Locator	getLocator()
String	getName()
protected String	getOptionalAttribute(Attributes atts, String name, String defaultValue)
protected Boolean	getOptionalBooleanAttribute(Attributes atts, String name, Boolean defaultValue)
protected Integer	getOptionalIntAttribute(Attributes atts, String name, Integer defaultValue)
protected Long	getOptionalLongAttribute(Attributes atts, String name, Long defaultValue)
DelegatingHandler	getParent()
protected String	getRequiredAttribute(Attributes atts, String name)
protected boolean	getRequiredBooleanAttribute(Attributes atts, String name)
protected int	getRequiredIntAttribute(Attributes atts, String name, Integer logLevel)
protected long	getRequiredLongAttribute(Attributes atts, String name)
protected void	handleAttributes(Attributes atts)	Called when the expected node is achieved; nothing to do by default.
final void	ignorableWhitespace(char[] ch, int start, int length)
boolean	isBufferingChar()
protected void	log(int logLevel, String message)
protected void	log(int logLevel, String message, Throwable t)
final void	notationDecl(String name, String publicId, String systemId)
final void	processingInstruction(String target, String data)
void	setBufferingChar(boolean bufferingChar)
void	setDocumentLocator(Locator locator)
void	setSkipOnError(boolean skipOnError)
void	skip()
final void	skippedEntity(String name)
final void	startDocument()
final void	startElement(String uri, String localName, String n, Attributes atts)
final void	startPrefixMapping(String prefix, String uri)
protected void	stopDelegating()
final void	unparsedEntityDecl(String name, String publicId, String systemId, String notationName)
final void	warning(SAXParseException exception)

Methods inherited from class DefaultHandler

resolveEntity

Methods inherited from class Object

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

Methods inherited from interface ContentHandler

declaration

Constructor Details

DelegatingHandler

public DelegatingHandler(String name)

Method Details

addChild

protected <DH extends DelegatingHandler> void addChild(DH saxHandler,
 DelegatingHandler.ChildElementHandler<DH> elementHandler)

getName

public String getName()

getParent

public DelegatingHandler getParent()

setBufferingChar

public void setBufferingChar(boolean bufferingChar)

setSkipOnError

public void setSkipOnError(boolean skipOnError)

isBufferingChar

public boolean isBufferingChar()

getBufferedChars

public String getBufferedChars()

setDocumentLocator

public void setDocumentLocator(Locator locator)

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class DefaultHandler

getLocator

public Locator getLocator()

getCurrentElementIdentifier

protected String getCurrentElementIdentifier()

Return an sort of identifier of the current element being parsed. It will only be used for logging purpose.

Returns:

an empty string by default

skip

public void skip()

stopDelegating

protected void stopDelegating()

startDocument

public final void startDocument()
                         throws SAXException

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class DefaultHandler

Throws:

SAXException

doStartDocument

protected void doStartDocument()
                        throws SAXException

By default do nothing.

Throws:

SAXException - API told me so

endDocument

public final void endDocument()
                       throws SAXException

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class DefaultHandler

Throws:

SAXException

doEndDocument

protected void doEndDocument()
                      throws SAXException

By default do nothing.

Throws:

SAXException - API told me so

startElement

public final void startElement(String uri,
 String localName,
 String n,
 Attributes atts)
                        throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

handleAttributes

protected void handleAttributes(Attributes atts)
                         throws SAXException

Called when the expected node is achieved; nothing to do by default.

Parameters:

atts - the xml attributes attached to the expected node

Throws:

SAXException - in case the parsing should be completely stopped

doStartElement

protected void doStartElement(String uri,
 String localName,
 String name,
 Attributes atts)
                       throws SAXException

By default do nothing.

Parameters:

uri - String

localName - String

name - String

atts - Attributes

Throws:

SAXException - API told me so

endElement

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

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

doEndElement

protected void doEndElement(String uri,
 String localName,
 String name)
                     throws SAXException

By default do nothing.

Parameters:

uri - String

localName - String

name - String

Throws:

SAXException - API told me so

characters

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

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

doCharacters

protected void doCharacters(char[] ch,
 int start,
 int length)
                     throws SAXException

Parameters:

ch - char[]

start - int

length - int

Throws:

SAXException - if something goes wrong

startPrefixMapping

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

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class DefaultHandler

Throws:

SAXException

doStartPrefixMapping

protected void doStartPrefixMapping(String prefix,
 String uri)
                             throws SAXException

By default do nothing.

Parameters:

prefix - String

uri - String

Throws:

SAXException - API told me so

endPrefixMapping

public final void endPrefixMapping(String prefix)
                            throws SAXException

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class DefaultHandler

Throws:

SAXException

doEndPrefixMapping

protected void doEndPrefixMapping(String prefix)
                           throws SAXException

By default do nothing.

Parameters:

prefix - String

Throws:

SAXException - API told me so

ignorableWhitespace

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

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class DefaultHandler

Throws:

SAXException

doIgnorableWhitespace

protected void doIgnorableWhitespace(char[] ch,
 int start,
 int length)
                              throws SAXException

By default do nothing

Parameters:

ch - char[]

start - int

length - int

Throws:

SAXException - API told me so

notationDecl

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

Specified by:

notationDecl in interface DTDHandler

Overrides:

notationDecl in class DefaultHandler

Throws:

SAXException

doNotationDecl

protected void doNotationDecl(String name,
 String publicId,
 String systemId)
                       throws SAXException

By default do nothing.

Parameters:

name - String

publicId - String

systemId - String

Throws:

SAXException - API told me so

processingInstruction

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

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class DefaultHandler

Throws:

SAXException

doProcessingInstruction

protected void doProcessingInstruction(String target,
 String data)
                                throws SAXException

By default do nothing

Parameters:

target - String

data - String

Throws:

SAXException - API told me so

skippedEntity

public final void skippedEntity(String name)
                         throws SAXException

Specified by:

skippedEntity in interface ContentHandler

Overrides:

skippedEntity in class DefaultHandler

Throws:

SAXException

doSkippedEntity

protected void doSkippedEntity(String name)
                        throws SAXException

By default do nothing.

Parameters:

name - String

Throws:

SAXException - API told me so

unparsedEntityDecl

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

Specified by:

unparsedEntityDecl in interface DTDHandler

Overrides:

unparsedEntityDecl in class DefaultHandler

Throws:

SAXException

doUnparsedEntityDecl

protected void doUnparsedEntityDecl(String name,
 String publicId,
 String systemId,
 String notationName)
                             throws SAXException

By default do nothing.

Parameters:

name - String

publicId - String

systemId - String

notationName - String

Throws:

SAXException - API told me so

warning

public final void warning(SAXParseException exception)
                   throws SAXException

Specified by:

warning in interface ErrorHandler

Overrides:

warning in class DefaultHandler

Throws:

SAXException

doWarning

protected void doWarning(SAXParseException exception)
                  throws SAXException

By default do nothing.

Parameters:

exception - SAXParseException

Throws:

SAXException - API told me so

error

public final void error(SAXParseException exception)
                 throws SAXException

Specified by:

error in interface ErrorHandler

Overrides:

error in class DefaultHandler

Throws:

SAXException

doError

protected void doError(SAXParseException exception)
                throws SAXException

By default do nothing.

Parameters:

exception - SAXParseException

Throws:

SAXException - API told me so

fatalError

public final void fatalError(SAXParseException exception)
                      throws SAXException

Specified by:

fatalError in interface ErrorHandler

Overrides:

fatalError in class DefaultHandler

Throws:

SAXException

doFatalError

protected void doFatalError(SAXParseException exception)
                     throws SAXException

By default do nothing.

Parameters:

exception - SAXParseException

Throws:

SAXException - API told me so

log

protected void log(int logLevel,
 String message,
 Throwable t)

log

protected void log(int logLevel,
 String message)

getLocation

protected static String getLocation(Locator locator)

getRequiredAttribute

protected String getRequiredAttribute(Attributes atts,
 String name)
                               throws SAXParseException

Throws:

SAXParseException

getOptionalAttribute

protected String getOptionalAttribute(Attributes atts,
 String name,
 String defaultValue)

getRequiredIntAttribute

protected int getRequiredIntAttribute(Attributes atts,
 String name,
 Integer logLevel)
                               throws SAXParseException

Throws:

SAXParseException

getOptionalIntAttribute

protected Integer getOptionalIntAttribute(Attributes atts,
 String name,
 Integer defaultValue)
                                   throws SAXParseException

Throws:

SAXParseException

getRequiredLongAttribute

protected long getRequiredLongAttribute(Attributes atts,
 String name)
                                 throws SAXParseException

Throws:

SAXParseException

getOptionalLongAttribute

protected Long getOptionalLongAttribute(Attributes atts,
 String name,
 Long defaultValue)
                                 throws SAXParseException

Throws:

SAXParseException

getRequiredBooleanAttribute

protected boolean getRequiredBooleanAttribute(Attributes atts,
 String name)
                                       throws SAXParseException

Throws:

SAXParseException

getOptionalBooleanAttribute

protected Boolean getOptionalBooleanAttribute(Attributes atts,
 String name,
 Boolean defaultValue)
                                       throws SAXParseException

Throws:

SAXParseException