This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 41519 - Refactoring module API review
Summary: Refactoring module API review
Status: RESOLVED FIXED
Alias: None
Product: editor
Classification: Unclassified
Component: Refactoring (show other bugs)
Version: 4.x
Hardware: PC Windows ME/2000
: P3 blocker (vote)
Assignee: issues@java
URL: http://openide.netbeans.org/tutorial/...
Keywords: API_REVIEW
Depends on:
Blocks:
 
Reported: 2004-03-30 17:09 UTC by Martin Matula
Modified: 2007-04-03 18:02 UTC (History)
1 user (show)

See Also:
Issue Type: TASK
Exception Reporter:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Matula 2004-03-30 17:09:42 UTC 
I would like to kindly ask for architecture 
review of Refactoring module. Answers to the 
architecture questions can be found at 
refactoring/arch, zip file with API javadocs can 
be found in module's files area.
Comment 1 _ tboudreau 2004-04-01 20:05:13 UTC 
Some comments off the top of my head - feel free to ignore if I am
missing the point of something...

The design pattern of EncapsulateFields seems a little weird - it
looks like an event listener (start, stop and step taking event
arguments), but it also appears to fire the same type of event it's
being passed. I guess what's making me focus on this class is how
different its API is from the other refactorings - probably because
encapsulating fields is a multi step operation - it looks sort of like
one class doing the job of two - but I may just not understand what
you're trying to do here.  

In general, an overview page and a pass through all the public methods
to make sure there's at least some description would be helpful, and
some kind of overview describing expected usage patterns would be welcome.

Mostly it's unclear from the Javadoc what you're supposed to do with
an AbstractRefactoring class once you've created it - or what is
supposed to be in the various Collection arguments.
Comment 2 Martin Matula 2004-04-05 18:09:45 UTC 
I have cleaned the API a little bit. You are right that there were a
lot of methods/classes that should not be there. It is because it is
still under development and we did not take time yet to clean it.
That's one of the reasons why we do not want to make it stable. I have
also added the javadoc for org.netbeans.api.refactoring.ui package,
which (as I lately realized) was missing from the original
RefactoringAPIs.zip. We can discuss further changes to the APIs at the
Refactoring DevRev meeting. The new zip can be downloaded from the
files area of refactoring module.
Tim and Yarda, thanks for your comments.
Comment 3 Jaroslav Tulach 2004-05-25 15:15:49 UTC 
Draft of the opinion provided at 
http://openide.netbeans.org/tutorial/reviews/opinions_41519.html
Comment 4 Martin Matula 2004-06-20 11:40:05 UTC 
After agreement with DevRev team, the refactoring module will not
provide an API for promoD (the proposed API was repackaged).