Stay organized with collections
Save and categorize content based on your preferences.
XMLReaderFactory
class XMLReaderFactory
Factory for creating an XML reader. 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 contains static methods for creating an XML reader from an explicit class name, or based on runtime defaults:
try {
XMLReader myReader = XMLReaderFactory.createXMLReader();
} catch (SAXException e) {
System.err.println(e.getMessage());
}
Note to Distributions bundled with parsers: You should modify the implementation of the no-arguments createXMLReader to handle cases where the external configuration mechanisms aren't set up. That method should do its best to return a parser when one is in the class path, even when nothing bound its class name to org.xml.sax.driver so those configuration mechanisms would see it.
Summary
| Public methods |
| static XMLReader! |
Attempt to create an XMLReader from system defaults.
|
| static XMLReader! |
Attempt to create an XML reader from a class name.
|
Public methods
createXMLReader
static fun createXMLReader(): XMLReader!
Attempt to create an XMLReader from system defaults. In environments which can support it, the name of the XMLReader class is determined by trying each these options in order, and using the first one which succeeds:
- If the system property
org.xml.sax.driver has a value, that is used as an XMLReader class name.
- The JAR "Services API" is used to look for a class name in the META-INF/services/org.xml.sax.driver file in jarfiles available to the runtime.
- SAX parser distributions are strongly encouraged to provide a default XMLReader class name that will take effect only when previous options (on this list) are not successful.
- Finally, if
ParserFactory.makeParser() can return a system default SAX1 parser, that parser is wrapped in a ParserAdapter. (This is a migration aid for SAX1 environments, where the org.xml.sax.parser system property will often be usable.)
In environments such as small embedded systems, which can not support that flexibility, other mechanisms to determine the default may be used.
Note that many Java environments allow system properties to be initialized on a command line. This means that in most cases setting a good value for that property ensures that calls to this method will succeed, except when security policies intervene. This will also maximize application portability to older SAX environments, with less robust implementations of this method.
| Exceptions |
org.xml.sax.SAXException |
If no default XMLReader class can be identified and instantiated. |
createXMLReader
static fun createXMLReader(className: String!): XMLReader!
Attempt to create an XML reader from a class name.
Given a class name, this method attempts to load and instantiate the class as an XML reader.
| Parameters |
className |
String!: the name of the class that should be instantiated.
Note that this method will not be usable in environments where the caller (perhaps an applet) is not permitted to load classes dynamically.
|
| Exceptions |
org.xml.sax.SAXException |
If the class cannot be loaded, instantiated, and cast to XMLReader. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# XMLReaderFactory\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nXMLReaderFactory\n================\n\n```\nclass XMLReaderFactory\n```\n\n|---|-------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [org.xml.sax.helpers.XMLReaderFactory](#) |\n\nFactory for creating an XML reader. *This module, both source code and documentation, is in the Public Domain, and comes with **NO WARRANTY**.* See \u003chttp://www.saxproject.org\u003e for further information.\n\nThis class contains static methods for creating an XML reader from an explicit class name, or based on runtime defaults: \n\n```kotlin\ntry {\n XMLReader myReader = XMLReaderFactory.createXMLReader();\n } catch (SAXException e) {\n System.err.println(e.getMessage());\n }\n \n```\n\n**Note to Distributions bundled with parsers:** You should modify the implementation of the no-arguments *createXMLReader* to handle cases where the external configuration mechanisms aren't set up. That method should do its best to return a parser when one is in the class path, even when nothing bound its class name to `org.xml.sax.driver` so those configuration mechanisms would see it.\n\nSummary\n-------\n\n| Public methods ||\n|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| static [XMLReader](../XMLReader.html#)! | [createXMLReader](#createXMLReader())`()` Attempt to create an XMLReader from system defaults. |\n| static [XMLReader](../XMLReader.html#)! | [createXMLReader](#createXMLReader(kotlin.String))`(`className:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Attempt to create an XML reader from a class name. |\n\nPublic methods\n--------------\n\n### createXMLReader\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic fun createXMLReader(): XMLReader!\n```\n\nAttempt to create an XMLReader from system defaults. In environments which can support it, the name of the XMLReader class is determined by trying each these options in order, and using the first one which succeeds:\n\n\u003cbr /\u003e\n\n- If the system property `org.xml.sax.driver` has a value, that is used as an XMLReader class name.\n- The JAR \"Services API\" is used to look for a class name in the *META-INF/services/org.xml.sax.driver* file in jarfiles available to the runtime.\n- SAX parser distributions are strongly encouraged to provide a default XMLReader class name that will take effect only when previous options (on this list) are not successful.\n- Finally, if [ParserFactory.makeParser()](/reference/kotlin/org/xml/sax/helpers/ParserFactory#makeParser()) can return a system default SAX1 parser, that parser is wrapped in a [ParserAdapter](/reference/kotlin/org/xml/sax/helpers/ParserAdapter). (This is a migration aid for SAX1 environments, where the `org.xml.sax.parser` system property will often be usable.)\n\nIn environments such as small embedded systems, which can not support that flexibility, other mechanisms to determine the default may be used.\n\nNote that many Java environments allow system properties to be initialized on a command line. This means that *in most cases* setting a good value for that property ensures that calls to this method will succeed, except when security policies intervene. This will also maximize application portability to older SAX environments, with less robust implementations of this method.\n\n| Return ||\n|----------------------------------|------------------|\n| [XMLReader](../XMLReader.html#)! | A new XMLReader. |\n\n| Exceptions ||\n|----------------------------|-------------------------------------------------------------------|\n| `org.xml.sax.SAXException` | If no default XMLReader class can be identified and instantiated. |\n\n**See Also**\n\n- [#createXMLReader(java.lang.String)](#createXMLReader(kotlin.String)) \n\n### createXMLReader\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic fun createXMLReader(className: String!): XMLReader!\n```\n\nAttempt to create an XML reader from a class name.\n\nGiven a class name, this method attempts to load and instantiate the class as an XML reader.\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `className` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!: the name of the class that should be instantiated. Note that this method will not be usable in environments where the caller (perhaps an applet) is not permitted to load classes dynamically. |\n\n| Return ||\n|----------------------------------|-------------------|\n| [XMLReader](../XMLReader.html#)! | A new XML reader. |\n\n| Exceptions ||\n|----------------------------|---------------------------------------------------------------------|\n| `org.xml.sax.SAXException` | If the class cannot be loaded, instantiated, and cast to XMLReader. |\n\n**See Also**\n\n- \u003c#createXMLReader()\u003e"]]
