Java Doc for HandlerBase.java in  » Development » Javolution » org » xml » sax » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Development » Javolution » org.xml.sax 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.xml.sax.HandlerBase

HandlerBase
public class HandlerBase implements EntityResolver,DTDHandler,DocumentHandler,ErrorHandler(Code)
Default base class for handlers.
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.

This class implements the default behaviour for four SAX1 interfaces: EntityResolver, DTDHandler, DocumentHandler, and ErrorHandler. It is now obsolete, but is included in SAX2 to support legacy SAX1 applications. SAX2 applications should use the org.xml.sax.helpers.DefaultHandler DefaultHandler class instead.

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

Note that the use of this class is optional.

org.xml.sax.DocumentHandler DocumentHandlerorg.xml.sax.helpers.DefaultHandler DefaultHandler
since:
   SAX 1.0
author:
   David Megginson
version:
   2.0.1 (sax2r2)
See Also:   org.xml.sax.EntityResolver
See Also:   org.xml.sax.DTDHandler
See Also:   org.xml.sax.DocumentHandler
See Also:   org.xml.sax.ErrorHandler




Method Summary
public  voidcharacters(char ch, int start, int length)
     Receive notification of character data inside an element.

By default, do nothing.

public  voidendDocument()
     Receive notification of the end of the document.

By default, do nothing.

public  voidendElement(String name)
     Receive notification of the end of an element.

By default, do nothing.

public  voiderror(SAXParseException e)
     Receive notification of a recoverable parser error.

The default implementation does nothing.

public  voidfatalError(SAXParseException e)
     Report a fatal XML parsing error.
public  voidignorableWhitespace(char ch, int start, int length)
     Receive notification of ignorable whitespace in element content.

By default, do nothing.

public  voidnotationDecl(String name, String publicId, String systemId)
     Receive notification of a notation declaration.

By default, do nothing.

public  voidprocessingInstruction(String target, String data)
     Receive notification of a processing instruction.

By default, do nothing.

public  InputSourceresolveEntity(String publicId, String systemId)
     Resolve an external entity.

Always return null, so that the parser will use the system identifier provided in the XML document.

public  voidsetDocumentLocator(Locator locator)
     Receive a Locator object for document events.

By default, do nothing.

public  voidstartDocument()
     Receive notification of the beginning of the document.

By default, do nothing.

public  voidstartElement(String name, AttributeList attributes)
     Receive notification of the start of an element.

By default, do nothing.

public  voidunparsedEntityDecl(String name, String publicId, String systemId, String notationName)
     Receive notification of an unparsed entity declaration.

By default, do nothing.

public  voidwarning(SAXParseException e)
     Receive notification of a parser warning.

The default implementation does nothing.




Method Detail
characters
public void characters(char ch, int start, int length) throws SAXException(Code)
Receive notification of character data inside an element.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file).


Parameters:
  ch - The characters.
Parameters:
  start - The start position in the character array.
Parameters:
  length - The number of characters to use from thecharacter array.
exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also:   org.xml.sax.DocumentHandler.characters



endDocument
public void endDocument() throws SAXException(Code)
Receive notification of the end of the document.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the beginning of a document (such as finalising a tree or closing an output file).


exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also:   org.xml.sax.DocumentHandler.endDocument



endElement
public void endElement(String name) throws SAXException(Code)
Receive notification of the end of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).


Parameters:
  name - the element name
exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also:   org.xml.sax.DocumentHandler.endElement



error
public void error(SAXParseException e) throws SAXException(Code)
Receive notification of a recoverable parser error.

The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each error, such as inserting the message in a log file or printing it to the console.


Parameters:
  e - The warning information encoded as an exception.
exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also:   org.xml.sax.ErrorHandler.warning
See Also:   org.xml.sax.SAXParseException



fatalError
public void fatalError(SAXParseException e) throws SAXException(Code)
Report a fatal XML parsing error.

The default implementation throws a SAXParseException. Application writers may override this method in a subclass if they need to take specific actions for each fatal error (such as collecting all of the errors into a single report): in any case, the application must stop all regular processing when this method is invoked, since the document is no longer reliable, and the parser may no longer report parsing events.


Parameters:
  e - The error information encoded as an exception.
exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also:   org.xml.sax.ErrorHandler.fatalError
See Also:   org.xml.sax.SAXParseException



ignorableWhitespace
public void ignorableWhitespace(char ch, int start, int length) throws SAXException(Code)
Receive notification of ignorable whitespace in element content.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of ignorable whitespace (such as adding data to a node or buffer, or printing it to a file).


Parameters:
  ch - The whitespace characters.
Parameters:
  start - The start position in the character array.
Parameters:
  length - The number of characters to use from thecharacter array.
exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also:   org.xml.sax.DocumentHandler.ignorableWhitespace



notationDecl
public void notationDecl(String name, String publicId, String systemId)(Code)
Receive notification of a notation declaration.

By default, do nothing. Application writers may override this method in a subclass if they wish to keep track of the notations declared in a document.


Parameters:
  name - The notation name.
Parameters:
  publicId - The notation public identifier, or null if notavailable.
Parameters:
  systemId - The notation system identifier.
See Also:   org.xml.sax.DTDHandler.notationDecl



processingInstruction
public void processingInstruction(String target, String data) throws SAXException(Code)
Receive notification of a processing instruction.

By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.


Parameters:
  target - The processing instruction target.
Parameters:
  data - The processing instruction data, or null ifnone is supplied.
exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also:   org.xml.sax.DocumentHandler.processingInstruction



resolveEntity
public InputSource resolveEntity(String publicId, String systemId) throws SAXException(Code)
Resolve an external entity.

Always return null, so that the parser will use the system identifier provided in the XML document. This method implements the SAX default behaviour: application writers can override it in a subclass to do special translations such as catalog lookups or URI redirection.


Parameters:
  publicId - The public identifer, or null if none isavailable.
Parameters:
  systemId - The system identifier provided in the XML document. The new input source, or null to require thedefault behaviour.
exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also:   org.xml.sax.EntityResolver.resolveEntity



setDocumentLocator
public void setDocumentLocator(Locator locator)(Code)
Receive a Locator object for document events.

By default, do nothing. Application writers may override this method in a subclass if they wish to store the locator for use with other document events.


Parameters:
  locator - A locator for all SAX document events.
See Also:   org.xml.sax.DocumentHandler.setDocumentLocator
See Also:   org.xml.sax.Locator



startDocument
public void startDocument() throws SAXException(Code)
Receive notification of the beginning of the document.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the beginning of a document (such as allocating the root node of a tree or creating an output file).


exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also:   org.xml.sax.DocumentHandler.startDocument



startElement
public void startElement(String name, AttributeList attributes) throws SAXException(Code)
Receive notification of the start of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writing output to a file).


Parameters:
  name - The element type name.
Parameters:
  attributes - The specified or defaulted attributes.
exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also:   org.xml.sax.DocumentHandler.startElement



unparsedEntityDecl
public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName)(Code)
Receive notification of an unparsed entity declaration.

By default, do nothing. Application writers may override this method in a subclass to keep track of the unparsed entities declared in a document.


Parameters:
  name - The entity name.
Parameters:
  publicId - The entity public identifier, or null if notavailable.
Parameters:
  systemId - The entity system identifier.
Parameters:
  notationName - The name of the associated notation.
See Also:   org.xml.sax.DTDHandler.unparsedEntityDecl



warning
public void warning(SAXParseException e) throws SAXException(Code)
Receive notification of a parser warning.

The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each warning, such as inserting the message in a log file or printing it to the console.


Parameters:
  e - The warning information encoded as an exception.
exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also:   org.xml.sax.ErrorHandler.warning
See Also:   org.xml.sax.SAXParseException



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.