Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 160303 - [ErrorHandling] New EH facility
Summary: [ErrorHandling] New EH facility
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.3   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: 3.3 M4   Edit
Assignee: Szymon Brandys CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 154090
  Show dependency tree
 
Reported: 2006-10-10 09:07 EDT by Szymon Brandys CLA
Modified: 2006-12-12 09:05 EST (History)
3 users (show)

See Also:


Attachments
EH facility - first steps (114.68 KB, patch)
2006-10-10 11:46 EDT, Szymon Brandys CLA
no flags Details | Diff
New test project for new error handling facility (10.90 KB, application/zip)
2006-10-11 08:09 EDT, Szymon Brandys CLA
no flags Details
Error handling facility - first steps (107.90 KB, patch)
2006-10-11 08:45 EDT, Szymon Brandys CLA
no flags Details | Diff
EH facility (116.83 KB, patch)
2006-10-12 07:13 EDT, Szymon Brandys CLA
no flags Details | Diff
Error handler schema (10.75 KB, text/plain)
2006-10-12 07:14 EDT, Szymon Brandys CLA
no flags Details
Status Handling Fac. 2006-11-02 (106.47 KB, patch)
2006-11-02 12:13 EST, Szymon Brandys CLA
no flags Details | Diff
Status Handling Fac. 2006-11-14 (10.31 KB, patch)
2006-11-14 09:02 EST, Szymon Brandys CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Szymon Brandys CLA 2006-10-10 09:07:02 EDT
 
Comment 1 Szymon Brandys CLA 2006-10-10 11:46:50 EDT
Created attachment 51705 [details]
EH facility - first steps
Comment 2 Tod Creasey CLA 2006-10-10 13:29:34 EDT
I have the following comments

if (workbenchErrorHandler == null) {
			workbenchErrorHandler = new WorkbenchErrorHandler();
		}
		return workbenchErrorHandler;

this code will create a WorkbenchErrorHandler is there isn't one specified. Where do you look in the registry?

What is ErrorDialog in the ide for?

Don't shortcut the names of classes. Use ErrorHandler everywhere not EH. People
can read faster than they can parse.

It is very hard to follow uncommented code. Please comment everything even if it is a draft.

We need a better name than whineMode. Perhaps reportingLevel or something like that. whine is too conversational

/*
	 * (Intentionally not javadoc'd) Implements the corresponding method on
	 * <code>IStatus</code>.
	 */

should use the default template here.

The schema should be clearer about how parameters are used. maybe extending the example would make it clearer.



Comment 3 Szymon Brandys CLA 2006-10-11 08:09:02 EDT
Created attachment 51748 [details]
New test project for new error handling facility
Comment 4 Szymon Brandys CLA 2006-10-11 08:45:51 EDT
Created attachment 51751 [details]
Error handling facility - first steps
Comment 5 Szymon Brandys CLA 2006-10-12 07:13:03 EDT
Created attachment 51843 [details]
EH facility

Changes to API. Documentation improved.
Comment 6 Szymon Brandys CLA 2006-10-12 07:14:12 EDT
Created attachment 51844 [details]
Error handler schema
Comment 7 Szymon Brandys CLA 2006-10-25 11:07:32 EDT
As we all agreed the word 'error' in the name of the facility isn't good.
We have to rename it and all parts which have 'error' in names.

The reason is that the facility isn't only for error statuses but it can handle
others as well. So I suggest to call it Status Handling and I'm waiting for other suggestions...

Of course all error handlers will be called status handlers.
Comment 8 Szymon Brandys CLA 2006-11-02 12:13:54 EST
Created attachment 53149 [details]
Status Handling Fac.  2006-11-02

The name of the facility changed into 'Status handling facility'
Comment 9 Tod Creasey CLA 2006-11-02 13:07:36 EST
Some comments 

AbstractStatusHandler needs better javadoc for it's getters and setters so that implementors know what they are doing. Same issue for StatusHandlingState

IDEWorkbenchAdvisor has some commented out code and some strange formatting of comments. We should tidy this up

org.eclipse.ui.errors should likely be renamed org.eclipse.ui.status to reflect the name changes

the schema should avoid things like "so far" in the comment. If we are planning to do more we don't need to confuse the user with vague promises. The Englush needs cleaning up but I can do that.



Comment 10 Tod Creasey CLA 2006-11-07 10:00:10 EST
Patch released with some small changes of naming etc. for build >20061107
Comment 11 Szymon Brandys CLA 2006-11-14 09:02:04 EST
Created attachment 53811 [details]
Status Handling Fac. 2006-11-14

EXPERIMENTAL tag added
schema error fixed (html tag <code> wasn't closed)