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


Ed,

Just to add to Arthur's comment. I see the JDT detection tool as a way for the users to say what classes they want to avoid, whereas, the scanning tool tells the users that they are using an API incorrectly. It's like Eclipse telling its consumers what they should and should not be using. Other differences between the two tools:

1. The scanning tool can be run from the command line environment.
2. The JDT detection tool operates on all Java-based projects, whereas, the scanning tool only operates on plug-in projects (or projects that belongs to a component).
3. The scanning tool allows you to enforce finer rules. For example, you can say that an interface can be referenced (used), but not implemented.

However, I do agree that we can probably shared some code between the two tools, and more importantly, we need to make sure the two tools do not overlap each other and that they do not confuse the users/developers.

Thanks,

Jeffrey Liu
IBM Rational Software - Performance Analyst
IBM Toronto Lab.
8200 Warden Ave. Markham, Ontario, L6G 1C7
Internal mail: D3/R8V/8200/MKM (D3-268)
T/L: 969 3531
Tel: (905) 413 3531
Fax: (905) 413 4920
jeffliu@xxxxxxxxxx



Arthur Ryman/Toronto/IBM@IBMCA
Sent by: wtp-dev-admin@xxxxxxxxxxx

02/08/2005 03:43 PM

Please respond to
wtp-dev

To
wtp-dev@xxxxxxxxxxx
cc
wtp-dev@xxxxxxxxxxx, wtp-dev-admin@xxxxxxxxxxx
Subject
RE: [wtp-dev] API Scanning Tool Available






Ed,


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
intranet: http://labweb.torolab.ibm.com/DRY6/


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

02/08/2005 02:42 PM

Please respond to
wtp-dev

To
<wtp-dev@xxxxxxxxxxx>
cc
Subject
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:

http://download.eclipse.org/downloads/drops/S-3.1M3-200411050810/eclipse-news-part1-M3.html
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
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[1]. Please review this and send your comments to this list.


[1] http://eclipse.org/webtools/development/apiscanner/apiscanner.html


Arthur Ryman,
Rational Desktop Tools Development


Back to the top