Bugzilla – Full Text Bug Listing
| Summary: | [Viewers] [JFace] Use exceptions instead of asserts when testing API parameters | ||
|---|---|---|---|
| Product: | [Eclipse Project] Platform | Reporter: | Michael Moser <mmo> |
| Component: | UI | Assignee: | Platform UI Triaged <platform-ui-triaged> |
| Status: | NEW --- | QA Contact: | |
| Severity: | enhancement | ||
| Priority: | P3 | CC: | susan, tom.schindl |
| Version: | 3.2 | ||
| Target Milestone: | --- | ||
| Hardware: | All | ||
| OS: | All | ||
| Whiteboard: | |||
I agree that throwing an IllegalArgumentException would be better in this case. Hitesh is now responsible for watching bugs in the [Viewers] component area. This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet. If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant. |
There are many places where JFace uses org.eclipse.jface.util.Assert. While I fully agree that Asserts are a fine thing if they are used to verify programming assumptions and internal consistency within a framework, they are a lousy way to check API parameters passed in! If such an assert fails a programmer gets little or no clue what is wrong and has to dig into JFace's source code to find out, why things fail. For the latter purpose please throw telling exceptions (like NullPointerException or IllegalArgumentException with some short msg.) instead of doing assertions! Example: I just got this: ------------------------------- org.eclipse.jface.util.Assert$AssertionFailedException: Assertion failed: at org.eclipse.jface.util.Assert.isTrue(Assert.java:182) at org.eclipse.jface.util.Assert.isTrue(Assert.java:167) at org.eclipse.jface.viewers.AbstractTreeViewer.assertContentProviderType(AbstractTreeViewer.java:2086) at org.eclipse.jface.viewers.TreeViewer.assertContentProviderType(TreeViewer.java:761) at org.eclipse.jface.viewers.StructuredViewer.setContentProvider(StructuredViewer.java:1518) at org.eclipse.jface.viewers.AbstractTreeViewer.setContentProvider(AbstractTreeViewer.java:2082) at myplugin.AnalysisView.createViewer(AnalysisView.java:263) ... ------------------------------- In my project I had just decided to change my view from a TableViewer to use a TreeViewer (formerly called a TableTreeViewer) instead and as turned out (but only by looking at the JFace source) I had forgotten to adapt the view's content provide to implement ITreeContentProvider or ITreePathContentProvider (instead of IStructuredContentProvider). If there would be an IllegalArgumentException("content provider not implementing ITreeContentProvider nor ITreePathContentProvider") or similar the reason for the exception would have been immediately clear to me. Michael