- java.lang.Object
-
- javax.xml.parsers.SAXParser
-
public abstract class SAXParser extends Object
Defines the API that wraps anXMLReader
implementation class. In JAXP 1.0, this class wrapped theParser
interface, however this interface was replaced by theXMLReader
. For ease of transition, this class continues to support the same name and interface as well as supporting new methods. An instance of this class can be obtained from theSAXParserFactory.newSAXParser()
method. Once an instance of this class is obtained, XML can be parsed from a variety of input sources. These input sources are InputStreams, Files, URLs, and SAX InputSources.This static method creates a new factory instance based on a system property setting or uses the platform default if no property has been defined.
The system property that controls which Factory implementation to create is named
As the content is parsed by the underlying parser, methods of the given"javax.xml.parsers.SAXParserFactory"
. This property names a class that is a concrete subclass of this abstract class. If no property is defined, a platform default will be used.HandlerBase
or theDefaultHandler
are called.Implementors of this class which wrap an underlaying implementation can consider using the
ParserAdapter
class to initially adapt their SAX1 implementation to work under this revised class.
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
SAXParser()
Protected constructor to prevent instaniation.
-
Method Summary
Methods Modifier and Type Method and Description abstract Parser
getParser()
Returns the SAX parser that is encapsultated by the implementation of this class.abstract Object
getProperty(String name)
Returns the particular property requested for in the underlying implementation ofXMLReader
.Schema
getSchema()
Get a reference to the theSchema
being used by the XML processor.abstract XMLReader
getXMLReader()
Returns theXMLReader
that is encapsulated by the implementation of this class.abstract boolean
isNamespaceAware()
Indicates whether or not this parser is configured to understand namespaces.abstract boolean
isValidating()
Indicates whether or not this parser is configured to validate XML documents.boolean
isXIncludeAware()
Get the XInclude processing mode for this parser.void
parse(File f, DefaultHandler dh)
Parse the content of the file specified as XML using the specifiedDefaultHandler
.void
parse(File f, HandlerBase hb)
Parse the content of the file specified as XML using the specifiedHandlerBase
.void
parse(InputSource is, DefaultHandler dh)
Parse the content givenInputSource
as XML using the specifiedDefaultHandler
.void
parse(InputSource is, HandlerBase hb)
Parse the content givenInputSource
as XML using the specifiedHandlerBase
.void
parse(InputStream is, DefaultHandler dh)
Parse the content of the givenInputStream
instance as XML using the specifiedDefaultHandler
.void
parse(InputStream is, DefaultHandler dh, String systemId)
Parse the content of the givenInputStream
instance as XML using the specifiedDefaultHandler
.void
parse(InputStream is, HandlerBase hb)
Parse the content of the givenInputStream
instance as XML using the specifiedHandlerBase
.void
parse(InputStream is, HandlerBase hb, String systemId)
Parse the content of the givenInputStream
instance as XML using the specifiedHandlerBase
.void
parse(String uri, DefaultHandler dh)
Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specifiedDefaultHandler
.void
parse(String uri, HandlerBase hb)
Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specifiedHandlerBase
.void
reset()
Reset thisSAXParser
to its original configuration.abstract void
setProperty(String name, Object value)
Sets the particular property in the underlying implementation ofXMLReader
.
-
-
-
Constructor Detail
-
SAXParser
protected SAXParser()
Protected constructor to prevent instaniation. Use
SAXParserFactory.newSAXParser()
.
-
-
Method Detail
-
reset
public void reset()
Reset this
SAXParser
to its original configuration.SAXParser
is reset to the same state as when it was created withSAXParserFactory.newSAXParser()
.reset()
is designed to allow the reuse of existingSAXParser
s thus saving resources associated with the creation of newSAXParser
s.The reset
SAXParser
is not guaranteed to have the sameSchema
Object
, e.g.Object.equals(Object obj)
. It is guaranteed to have a functionally equalSchema
.- Throws:
UnsupportedOperationException
- When Implementations do not override this method- Since:
- 1.5
-
parse
public void parse(InputStream is, HandlerBase hb) throws SAXException, IOException
Parse the content of the given
InputStream
instance as XML using the specifiedHandlerBase
. Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0.- Parameters:
is
- InputStream containing the content to be parsed.hb
- The SAX HandlerBase to use.- Throws:
IllegalArgumentException
- If the given InputStream is null.SAXException
- If parse produces a SAX error.IOException
- If an IO error occurs interacting with theInputStream
.- See Also:
DocumentHandler
-
parse
public void parse(InputStream is, HandlerBase hb, String systemId) throws SAXException, IOException
Parse the content of the given
InputStream
instance as XML using the specifiedHandlerBase
. Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0.- Parameters:
is
- InputStream containing the content to be parsed.hb
- The SAX HandlerBase to use.systemId
- The systemId which is needed for resolving relative URIs.- Throws:
IllegalArgumentException
- If the givenInputStream
isnull
.IOException
- If any IO error occurs interacting with theInputStream
.SAXException
- If any SAX errors occur during processing.- See Also:
version of this method instead.
-
parse
public void parse(InputStream is, DefaultHandler dh) throws SAXException, IOException
Parse the content of the givenInputStream
instance as XML using the specifiedDefaultHandler
.- Parameters:
is
- InputStream containing the content to be parsed.dh
- The SAX DefaultHandler to use.- Throws:
IllegalArgumentException
- If the given InputStream is null.IOException
- If any IO errors occur.SAXException
- If any SAX errors occur during processing.- See Also:
DocumentHandler
-
parse
public void parse(InputStream is, DefaultHandler dh, String systemId) throws SAXException, IOException
Parse the content of the givenInputStream
instance as XML using the specifiedDefaultHandler
.- Parameters:
is
- InputStream containing the content to be parsed.dh
- The SAX DefaultHandler to use.systemId
- The systemId which is needed for resolving relative URIs.- Throws:
IllegalArgumentException
- If the given InputStream is null.IOException
- If any IO errors occur.SAXException
- If any SAX errors occur during processing.- See Also:
version of this method instead.
-
parse
public void parse(String uri, HandlerBase hb) throws SAXException, IOException
Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specifiedHandlerBase
. Use of the DefaultHandler version of this method is recommended as theHandlerBase
class has been deprecated in SAX 2.0- Parameters:
uri
- The location of the content to be parsed.hb
- The SAX HandlerBase to use.- Throws:
IllegalArgumentException
- If the uri is null.IOException
- If any IO errors occur.SAXException
- If any SAX errors occur during processing.- See Also:
DocumentHandler
-
parse
public void parse(String uri, DefaultHandler dh) throws SAXException, IOException
Parse the content described by the giving Uniform Resource Identifier (URI) as XML using the specifiedDefaultHandler
.- Parameters:
uri
- The location of the content to be parsed.dh
- The SAX DefaultHandler to use.- Throws:
IllegalArgumentException
- If the uri is null.IOException
- If any IO errors occur.SAXException
- If any SAX errors occur during processing.- See Also:
DocumentHandler
-
parse
public void parse(File f, HandlerBase hb) throws SAXException, IOException
Parse the content of the file specified as XML using the specifiedHandlerBase
. Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0- Parameters:
f
- The file containing the XML to parsehb
- The SAX HandlerBase to use.- Throws:
IllegalArgumentException
- If the File object is null.IOException
- If any IO errors occur.SAXException
- If any SAX errors occur during processing.- See Also:
DocumentHandler
-
parse
public void parse(File f, DefaultHandler dh) throws SAXException, IOException
Parse the content of the file specified as XML using the specifiedDefaultHandler
.- Parameters:
f
- The file containing the XML to parsedh
- The SAX DefaultHandler to use.- Throws:
IllegalArgumentException
- If the File object is null.IOException
- If any IO errors occur.SAXException
- If any SAX errors occur during processing.- See Also:
DocumentHandler
-
parse
public void parse(InputSource is, HandlerBase hb) throws SAXException, IOException
Parse the content givenInputSource
as XML using the specifiedHandlerBase
. Use of the DefaultHandler version of this method is recommended as the HandlerBase class has been deprecated in SAX 2.0- Parameters:
is
- The InputSource containing the content to be parsed.hb
- The SAX HandlerBase to use.- Throws:
IllegalArgumentException
- If theInputSource
object isnull
.IOException
- If any IO errors occur.SAXException
- If any SAX errors occur during processing.- See Also:
DocumentHandler
-
parse
public void parse(InputSource is, DefaultHandler dh) throws SAXException, IOException
Parse the content givenInputSource
as XML using the specifiedDefaultHandler
.- Parameters:
is
- The InputSource containing the content to be parsed.dh
- The SAX DefaultHandler to use.- Throws:
IllegalArgumentException
- If theInputSource
object isnull
.IOException
- If any IO errors occur.SAXException
- If any SAX errors occur during processing.- See Also:
DocumentHandler
-
getParser
public abstract Parser getParser() throws SAXException
Returns the SAX parser that is encapsultated by the implementation of this class.- Returns:
- The SAX parser that is encapsultated by the implementation of this class.
- Throws:
SAXException
- If any SAX errors occur during processing.
-
getXMLReader
public abstract XMLReader getXMLReader() throws SAXException
Returns theXMLReader
that is encapsulated by the implementation of this class.- Returns:
- The XMLReader that is encapsulated by the implementation of this class.
- Throws:
SAXException
- If any SAX errors occur during processing.
-
isNamespaceAware
public abstract boolean isNamespaceAware()
Indicates whether or not this parser is configured to understand namespaces.- Returns:
- true if this parser is configured to understand namespaces; false otherwise.
-
isValidating
public abstract boolean isValidating()
Indicates whether or not this parser is configured to validate XML documents.- Returns:
- true if this parser is configured to validate XML documents; false otherwise.
-
setProperty
public abstract void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException
Sets the particular property in the underlying implementation of
XMLReader
. A list of the core features and properties can be found at http://sax.sourceforge.net/?selected=get-set.All implementations that implement JAXP 1.5 or newer are required to support the
XMLConstants.ACCESS_EXTERNAL_DTD
andXMLConstants.ACCESS_EXTERNAL_SCHEMA
properties.-
Setting the
XMLConstants.ACCESS_EXTERNAL_DTD
property restricts the access to external DTDs, external Entity References to the protocols specified by the property. If access is denied during parsing due to the restriction of this property,SAXException
will be thrown by the parse methods defined bySAXParser
.Setting the
XMLConstants.ACCESS_EXTERNAL_SCHEMA
property restricts the access to external Schema set by the schemaLocation attribute to the protocols specified by the property. If access is denied during parsing due to the restriction of this property,SAXException
will be thrown by the parse methods defined by theSAXParser
.
- Parameters:
name
- The name of the property to be set.value
- The value of the property to be set.- Throws:
SAXNotRecognizedException
- When the underlying XMLReader does not recognize the property name.SAXNotSupportedException
- When the underlying XMLReader recognizes the property name but doesn't support the property.- See Also:
XMLReader.setProperty(java.lang.String, java.lang.Object)
-
-
getProperty
public abstract Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException
Returns the particular property requested for in the underlying implementation of
XMLReader
.- Parameters:
name
- The name of the property to be retrieved.- Returns:
- Value of the requested property.
- Throws:
SAXNotRecognizedException
- When the underlying XMLReader does not recognize the property name.SAXNotSupportedException
- When the underlying XMLReader recognizes the property name but doesn't support the property.- See Also:
XMLReader.getProperty(java.lang.String)
-
getSchema
public Schema getSchema()
Get a reference to the the
Schema
being used by the XML processor.If no schema is being used,
null
is returned.- Returns:
Schema
being used ornull
if none in use- Throws:
UnsupportedOperationException
- When implementation does not override this method- Since:
- 1.5
-
isXIncludeAware
public boolean isXIncludeAware()
Get the XInclude processing mode for this parser.
- Returns:
- the return value of
the
SAXParserFactory.isXIncludeAware()
when this parser was created from factory. - Throws:
UnsupportedOperationException
- When implementation does not override this method- Since:
- 1.5
- See Also:
SAXParserFactory.setXIncludeAware(boolean)
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/xml/parsers/SAXParser.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.