Bug 170247 - [model] Document reasons to use or not use CompilationParticipant
Summary: [model] Document reasons to use or not use CompilationParticipant
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.3   Edit
Hardware: PC Windows XP
: P3 enhancement (vote)
Target Milestone: 3.3 M5   Edit
Assignee: Frederic Fusier CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-01-11 14:05 EST by Walter Harley CLA
Modified: 2007-02-06 03:38 EST (History)
0 users

See Also:

Attachments
proposed patch (1.31 KB, patch)
2007-01-11 14:17 EST, Walter Harley CLA 		no flags Details | Diff
View All 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 Walter Harley CLA 2007-01-11 14:05:40 EST 
We are starting to see people using CompilationParticipant because they think it is lighter-weight or easier than creating a Builder of their own.  (For instance, see the thread "How to detect errors during building?" on eclipse.tools.jdt, 2007.1.10.)

We should add a comment to the CompilationParticipant javadoc that explains that it should only be used when it is necessary to inject new Java source files into the compilation process.  People should be encouraged to write their own Builder unless they have a specific requirement for CompilationParticipant.

I'll attach a patch to this enhancement request, with suggested text.  This is a comment-only change.
Comment 1 Walter Harley CLA 2007-01-11 14:17:55 EST 
Created attachment 56790 [details]
proposed patch
Comment 2 Frederic Fusier CLA 2007-01-12 03:31:15 EST 
Released for 3.3 M5 in HEAD stream.
Comment 3 Maxime Daniel CLA 2007-02-06 03:38:32 EST 
Verified for 3.3 M5 using build I20070205-1824.