SAXEntityParser (XML Tools API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.api.xml/1 1.14

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.api.xml.parsers
Class SAXEntityParser

java.lang.Object
  org.netbeans.api.xml.parsers.SAXEntityParser

All Implemented Interfaces:: XMLReader

public class SAXEntityParser
extends Object
implements XMLReader
extends Object
implements XMLReader

SAX parser wrapper allowing to parse parsed XML entities (including DTDs) for wellformedness.

Default implementation cannot be used for parsing of XML document entities! It wraps client's parser that it actually used for performing the parsing task.

Primary use case (parse general entity):

   XMLReader entityParser = new SAXEntityParser(xmlReader);
   entityParser.setErrorHandler(errorHandler);
   entityParser.parse(inputSource);

Secondary use case (delegating parser): It requires subclassing and allow subclass entirely define internal wrapping logic. Warning: Implementation gurantees only proper ErrorHandler callbacks.

Constructor Summary

SAXEntityParser(XMLReader peer)
          Creates a new instance of general entity parser.

SAXEntityParser(XMLReader peer, boolean generalEntity)
          Creates a new instance of SAXEntityParser.

Method Summary

ContentHandler getContentHandler()


DTDHandler getDTDHandler()


EntityResolver getEntityResolver()


ErrorHandler getErrorHandler()


boolean getFeature(String name)


Object getProperty(String name)


void parse(InputSource entity)
          Start entity parsing using peer parser.

void parse(String sid)


protected boolean propagateException(SAXParseException ex)
          Examine if the exception should be propagated into client's ErrorHandler.

void setContentHandler(ContentHandler contentHandler)


void setDTDHandler(DTDHandler dTDHandler)


void setEntityResolver(EntityResolver entityResolver)


void setErrorHandler(ErrorHandler errorHandler)


void setFeature(String name, boolean val)


void setProperty(String name, Object val)


protected InputSource wrapInputSource(InputSource input)
          Create wrapper input source.

Methods inherited from class java.lang.Object

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

Constructor Summary
`SAXEntityParser(XMLReader peer)` Creates a new instance of general entity parser.
`SAXEntityParser(XMLReader peer, boolean generalEntity)` Creates a new instance of SAXEntityParser.

Method Summary
`ContentHandler`	`getContentHandler()`
`DTDHandler`	`getDTDHandler()`
`EntityResolver`	`getEntityResolver()`
`ErrorHandler`	`getErrorHandler()`
`boolean`	`getFeature(String name)`
`Object`	`getProperty(String name)`
`void`	`parse(InputSource entity)` Start entity parsing using peer parser.
`void`	`parse(String sid)`
`protected boolean`	`propagateException(SAXParseException ex)` Examine if the exception should be propagated into client's `ErrorHandler`.
`void`	`setContentHandler(ContentHandler contentHandler)`
`void`	`setDTDHandler(DTDHandler dTDHandler)`
`void`	`setEntityResolver(EntityResolver entityResolver)`
`void`	`setErrorHandler(ErrorHandler errorHandler)`
`void`	`setFeature(String name, boolean val)`
`void`	`setProperty(String name, Object val)`
`protected InputSource`	`wrapInputSource(InputSource input)` Create wrapper input source.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail