Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
RE: [wtp-dev] API Scanning Tool Available


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 during maintenance.

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 components.

Arthur Ryman,
Rational Desktop Tools Development

phone: +1-905-413-3077, TL 969-3077
assistant: +1-905-413-2411, TL 969-2411
fax: +1-905-413-4920, TL 969-4920
mobile: +1-416-939-5063, text: 4169395063@xxxxxxx

"Ed Burnette" <Ed.Burnette@xxxxxxx>
Sent by: wtp-dev-admin@xxxxxxxxxxx

02/08/2005 02:42 PM

Please respond to

RE: [wtp-dev] API Scanning Tool Available

The functionality appears to overlap 3.1M3/s "early detection of reference to internal classes" quite a bit, see:
It would be nice for any additional functionality the scanner provides to be folded into these existing integrated checks.
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
Tuesday, February 08, 2005 10:02 AM
bjorn@xxxxxxxxxxxx; cney@xxxxxxxxxxxxx; David M Williams; dominique.devito@xxxxxxxxxxxxx; Jochen Krause; mitch.sonies@xxxxxxxxxxxxx; naci.dai@xxxxxxxxxxxxx; wtp-dev@xxxxxxxxxxx
[wtp-dev] API Scanning Tool Available

Jeffrey Liu has published a Web page that describes the new API Scanner[1]. Please review this and send your comments to this list.


Arthur Ryman,
Rational Desktop Tools Development

Back to the top