Top Description Methods
org.xml.sax

public Interface Parser

Known Direct Implementers
org.xml.sax.helpers.XMLReaderAdapter, com.sun.org.apache.xerces.internal.parsers.AbstractSAXParser
Annotations
@Deprecated
since:1.5
Imports
java.io.IOException, java.util.Locale

Deprecated

since 1.5.

This interface has been replaced by the SAX2 XMLReader interface, which includes Namespace support.

Basic interface for SAX (Simple API for XML) parsers.

This was the main event supplier interface for SAX1; it has been replaced in SAX2 by XMLReader, which includes Namespace support and sophisticated configurability and extensibility.

All SAX1 parsers must implement this basic interface: it allows applications to register handlers for different types of events and to initiate a parse from a URI, or a character stream.

All SAX1 parsers must also implement a zero-argument constructor (though other constructors are also allowed).

SAX1 parsers are reusable but not re-entrant: the application may reuse a parser object (possibly with a different input source) once the first parse has completed successfully, but it may not invoke the parse() methods recursively within a parse.

Author
David Megginson
Since
1.4, SAX 1.0
See Also
org.xml.sax.EntityResolver, org.xml.sax.DTDHandler, org.xml.sax.DocumentHandler, org.xml.sax.ErrorHandler, org.xml.sax.HandlerBase, org.xml.sax.InputSource

Method Summary

Modifier and TypeMethod and Description
public void
parse(InputSource
The input source for the top-level of the XML document.
source
)

Parse an XML document.

public void
parse(String
The system identifier (URI).
systemId
)

Parse an XML document from a system identifier (URI).

public void
setDocumentHandler(DocumentHandler
The document handler.
handler
)
References Deprecated DocumentHandler is deprecated or references (maybe indirectly) at least one deprecated element.

Allow an application to register a document event handler.

public void
setDTDHandler(DTDHandler
The DTD handler.
handler
)

Allow an application to register a DTD event handler.

public void
setEntityResolver(EntityResolver
The object for resolving entities.
resolver
)

Allow an application to register a custom entity resolver.

public void
setErrorHandler(ErrorHandler
The error handler.
handler
)

Allow an application to register an error event handler.

public void
setLocale(Locale
A Java Locale object.
locale
)

Allow an application to request a locale for errors and warnings.

Method Detail

parseback to summary
public void parse(InputSource source) throws SAXException, IOException

Parse an XML document.

The application can use this method to instruct the SAX parser to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).

Applications may not invoke this method while a parse is in progress (they should create a new Parser instead for each additional XML document). Once a parse is complete, an application may reuse the same Parser object, possibly with a different input source.

Parameters
source:InputSource

The input source for the top-level of the XML document.

Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
IOException:
An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
See Also
org.xml.sax.InputSource, parse(java.lang.String), setEntityResolver, setDTDHandler, setDocumentHandler, setErrorHandler
parseback to summary
public void parse(String systemId) throws SAXException, IOException

Parse an XML document from a system identifier (URI).

This method is a shortcut for the common case of reading a document from a system identifier. It is the exact equivalent of the following:

parse(new InputSource(systemId));

If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser.

Parameters
systemId:String

The system identifier (URI).

Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
IOException:
An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
See Also
parse(org.xml.sax.InputSource)
setDocumentHandlerback to summary
public void setDocumentHandler(DocumentHandler handler)

References Deprecated

DocumentHandler is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Allow an application to register a document event handler.

If the application does not register a document handler, all document events reported by the SAX parser will be silently ignored (this is the default behaviour implemented by HandlerBase).

Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.

Parameters
handler:DocumentHandler

The document handler.

See Also
DocumentHandler, HandlerBase
setDTDHandlerback to summary
public void setDTDHandler(DTDHandler handler)

Allow an application to register a DTD event handler.

If the application does not register a DTD handler, all DTD events reported by the SAX parser will be silently ignored (this is the default behaviour implemented by HandlerBase).

Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.

Parameters
handler:DTDHandler

The DTD handler.

See Also
DTDHandler, HandlerBase
setEntityResolverback to summary
public void setEntityResolver(EntityResolver resolver)

Allow an application to register a custom entity resolver.

If the application does not register an entity resolver, the SAX parser will resolve system identifiers and open connections to entities itself (this is the default behaviour implemented in HandlerBase).

Applications may register a new or different entity resolver in the middle of a parse, and the SAX parser must begin using the new resolver immediately.

Parameters
resolver:EntityResolver

The object for resolving entities.

See Also
EntityResolver, HandlerBase
setErrorHandlerback to summary
public void setErrorHandler(ErrorHandler handler)

Allow an application to register an error event handler.

If the application does not register an error event handler, all error events reported by the SAX parser will be silently ignored, except for fatalError, which will throw a SAXException (this is the default behaviour implemented by HandlerBase).

Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.

Parameters
handler:ErrorHandler

The error handler.

See Also
ErrorHandler, SAXException, HandlerBase
setLocaleback to summary
public void setLocale(Locale locale) throws SAXException

Allow an application to request a locale for errors and warnings.

SAX parsers are not required to provide localisation for errors and warnings; if they cannot support the requested locale, however, they must throw a SAX exception. Applications may not request a locale change in the middle of a parse.

Parameters
locale:Locale

A Java Locale object.

Exceptions
SAXException:
Throws an exception (using the previous or default locale) if the requested locale is not supported.
See Also
org.xml.sax.SAXException, org.xml.sax.SAXParseException