Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 207773 - [Workbench] IMemento reference incomplete
Summary: [Workbench] IMemento reference incomplete
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.3.1   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 4.2 M4   Edit
Assignee: Paul Webster CLA
QA Contact: Paul Webster CLA
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-10-29 09:22 EDT by anatoly techtonik CLA
Modified: 2011-11-14 05:20 EST (History)
3 users (show)

See Also:

Attachments
Update javadoc v01 (7.11 KB, patch)
2010-11-09 15:04 EST, Paul Webster CLA 		no flags Details | Diff
Update XMLMemento javadoc v01 (6.76 KB, patch)
2010-12-06 10:04 EST, Paul Webster 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 anatoly techtonik CLA 2007-10-29 09:22:41 EDT 
Build ID: M20070921-1145

It would be nice to know that getChild() can return nulls and that keys specified to setString()/getString(), for example, should be valid XML names (see bug #122341)

More information:
http://help.eclipse.org/stable/index.jsp?topic=/org.eclipse.platform.doc.isv/reference/api/org/eclipse/ui/actions/WorkingSetFilterActionGroup.html
Comment 1 Dani Megert CLA 2007-10-29 09:34:59 EDT 
And either IMemento or XMLMemento should mention that it can throw a DOMException.
Comment 2 Paul Webster CLA 2010-04-12 09:43:26 EDT 
I'll leave this open for the DOMException and fix the other problems mentioned as bug 122341

PW
Comment 3 Paul Webster CLA 2010-11-09 15:04:28 EST 
Created attachment 182764 [details]
Update javadoc v01

I've added DOMException to the methods in XMLMemento that can throw it.  I've also updated the class javadoc for IMement to note that the default implementation can throw DOMExceptions.

PW
Comment 4 Paul Webster CLA 2010-11-15 13:27:47 EST 
(In reply to comment #3)
> Created an attachment (id=182764) [details]
> Update javadoc v01

Released to HEAD
PW
Comment 5 Dani Megert CLA 2010-11-16 03:17:46 EST 
The DOMException should be documented in the Javadoc ;-)
Comment 6 Paul Webster CLA 2010-11-16 07:04:48 EST 
Would you like me to mention it in the javadoc in the IMemento (as a note our default implementation can throw DOMException) or simply in the XMLMemento?

I'll get this in M4, I swear :-)

PW
Comment 7 Dani Megert CLA 2010-11-16 07:09:11 EST 
(In reply to comment #6)
> Would you like me to mention it in the javadoc in the IMemento (as a note our
> default implementation can throw DOMException) or simply in the XMLMemento?
> 
> I'll get this in M4, I swear :-)
> 
> PW

It looks like the exception is only needed in the implementation.
Comment 8 Paul Webster CLA 2010-12-06 10:04:21 EST 
Created attachment 184608 [details]
Update XMLMemento javadoc v01
Comment 9 Paul Webster CLA 2010-12-06 10:06:01 EST 
Released for M4
PW
Comment 10 Dani Megert CLA 2010-12-07 03:10:32 EST 
Verified in I20101206-1800.
Comment 11 Dani Megert CLA 2011-10-06 05:16:46 EDT 
Those changes didn't make it into 4.x.
Comment 13 Dani Megert CLA 2011-11-14 05:20:52 EST 
Verified in 'master'.