|
| | | | What part of the API is public, and what is subject to change? | | | | |
| | |
To answer this question, let us clearly define the terms we use
for API status:
- Public - This is the API that the typical client developer should code
against. An attempt will be made to fix any severe bugs in this API. Also,
much of this API that we define as "public" has reached W3C Recommendation status
or a similar status in xml-dev working group. Not much change in these interfaces
is expected.
- Experimental - These interfaces and classes reflect the latest W3C
specifications and SAX specifications from the xml-dev working group. Since
these specifications are not finalized, the interfaces are subject to
change. As some of these experimental specifications find their way through
the working groups to the highest level, such as W3C Recommendation, they
will be upgraded to the "Public" category.
- Internal - These classes are considered to be internal to Xerces, even
though they may be public and have public methods. They can be used by
developers who have complex and specific needs, such as building their
own XML Parser. However, please note that the architecture is subject to change.
|
API status
|
API contents (packages, interfaces, classes and methods)
|
Comments
|
| Public
|
DOM Level 1 interfaces (found in org.w3c.dom, org.w3c.dom.html)
SAX Level 1 interfaces (found in org.xml.sax. and subpackages)
org.apache.xerces.parsers.SAXParser, org.apache.xerces.parsers.DOMParser
|
The DOM1 and SAX1 Interfaces are stable, and they are identical to the specifications.
The DOMParser and SAXParser
are Xerces-specific, because currently there is no universal API for parser access and configuration.
This issue
is being discussed in the DOM Level 3 working group, and Xerces will provide feedback and will track the progress in
this area.
|
| Experimental
|
DOM Level 2 (DOM2) interfaces (found in org.w3c.dom and subpackages)
The DOM2 interfaces have been implemented in the same interfaces as DOM1, but as new methods.
These new DOM2 methods are clearly identified in the Javadoc API documentation as
"Since: DOM Level 2 ".
In addition, you may refer to the DOM2 specification, and more specifically, to
Appendix A which describes the changes between DOM1 and DOM2.
SAX Level 2 (SAX2) interfaces
(found in org.xml.sax. and subpackages). You can identify the SAX2 differences by visting:
changes between SAX2 and SAX1.
|
The DOM2 interfaces are in the Candidate Recommendation (CR) phase. This phase allows for implementors like Xerces
to provide feedback about the API. Therefore some parts of the API may change, but the specification is pretty
far along in the process toward final Recommendation.
The SAX2 interfaces have changed significantly from "beta1" to the current "beta2", which is
implemented in this release. It is unclear whether they may change significantly again before becoming finalized.
|
| Internal
|
All other packages are considered to be internal.
|
The internal Xerces architecture may change.
|
Please note that as an Apache Open Source project, the Xerces community is very interested in your questions
and feedback regarding the whole API, not only that part designated above as public.
If you have specific questions,
patches, or feedback regarding the Xerces API or code, you may visit the Apache Web site, and sign up for the mailing list. Otherwise more basic questions, or questions specific to XML4J,
can be sent to AlphaWorks discussion forum.
|
| | |
- December 9, 1999: version 3.0.0EA3
First version derived from Xerces-J code base.
Supply XML4J 2.0.x compatibility API.
- March 10, 2000: version 3.0.1
This version is derived from the Xerces 1.0.3 release.
It continues to include the deprecated XML4J 2.0.x compatibility API
as a separate jar.
|
|
|
