Actually, creating the component.xml
file is a lot easier than touching all the source files. We are also looking
at annotations for additional info. The component.xml files are designed
so that if you organize your code correctly, there is minimal work (e.g.
a package does not contain a mixture of API and non-API types, an API type
does not contain a mixture of API and non-API methods).
Another view is that the component.xml
files define the architecture and the code has to agree with that, i.e.
the API is not just what the code says since that is harder to control
The real advantage of the component.xml
file is that you can scan your component without needing access to the
component code you use - you just need the component.xml for each of those
Maintaning the component xml files
looks painful. Why not keep the annotations for things like "clients
shouldn't implement this interface" in the source code itself, either
through special comments or later through J2SE5 annotations?
From: wtp-dev-admin@xxxxxxxxxxx [mailto:wtp-dev-admin@xxxxxxxxxxx]
On Behalf Of Arthur Ryman
Sent: Tuesday, February 08, 2005 10:02 AM
To: bjorn@xxxxxxxxxxxx; cney@xxxxxxxxxxxxx; David M Williams; dominique.devito@xxxxxxxxxxxxx;
Jochen Krause; mitch.sonies@xxxxxxxxxxxxx; naci.dai@xxxxxxxxxxxxx; wtp-dev@xxxxxxxxxxx
Subject: [wtp-dev] API Scanning Tool Available
Jeffrey Liu has published a Web page that describes the new API Scanner.
Please review this and send your comments to this list.