Bug 89026 - [WorkingSets] ILocalWorkingSetManager marked as under construction
Summary: [WorkingSets] ILocalWorkingSetManager marked as under construction
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.1   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.1 M6   Edit
Assignee: Nick Edgar CLA
QA Contact:
URL:
Whiteboard:
Keywords: api
Depends on:
Blocks:
 
Reported: 2005-03-24 14:21 EST by Tod Creasey CLA
Modified: 2005-06-13 13:28 EDT (History)
1 user (show)

See Also:


Attachments
Patch for Javadoc changes (2.04 KB, patch)
2005-03-31 09:59 EST, Nick Edgar CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Tod Creasey CLA 2005-03-24 14:21:24 EST
ILocalWorkingSetManager marked as under construction
Comment 1 Dirk Baeumer CLA 2005-03-27 08:27:32 EST
Nick,

JDT/UI makes use of the ILocalWorkingSetManager interface. In addition to
removing the under construction clause we should make a reference to
IWorkbench#createLocalWorkingSet which is the factory method to create a working
set.

Additional API problems I found:

IWorkingSetManager#dispose: is under construction as well. The method is in use
and we should keep it.

IWorkingSetManager#createWorkingSetNewWizard: can be removed. The method got
introduced in 3.1 and is now deprecatred.
Comment 2 Nick Edgar CLA 2005-03-30 15:05:57 EST
Dirk, what is the main distinction between an ILocalWorkingSetManager and an
IWorkingSetManager again?  The current Javadoc doesn't really spell this out
clearly.  When should I use one vs. the other?

If you could provide a patch to the Javadoc clarifying its role, that would be
great.
Comment 3 Nick Edgar CLA 2005-03-30 15:10:50 EST
I've fixed up the issues in comment 0 and comment 1.
Comment 4 Nick Edgar CLA 2005-03-30 15:13:14 EST
Also removed the "under construction" comment from
IWorkbench.createLocalWorkingSetManager().

Scanned for other "experimental" or "under construction" comments in this area,
and found none.
Comment 5 Dirk Baeumer CLA 2005-03-31 09:33:22 EST
Nick,

here an updated version of the comment. Creating a patch requires checking out
ui.workbench....

/**
 * A local working set manager can be used to manage a set of
 * working sets independent from the working sets managed by 
 * the workspace wide working set manager. A local working set
 * manager can be saved and restored using the methods <code>saveState</code>  
 * and <code>restoreState</code>. A new local working set manager can be created  
 * using {@link org.eclipse.ui.IWorkbench#createLocalWorkingSetManager()}.
 * <p>
 * This interface is not intended to be implemented or extended by clients.
 * </p>
 *
 * @see org.eclipse.ui.IWorkbench#createLocalWorkingSetManager()
 * @since 3.1
 */
Comment 6 Nick Edgar CLA 2005-03-31 09:59:47 EST
Created attachment 19404 [details]
Patch for Javadoc changes

Thanks Dirk.  I made some slight tweaks to the wording.
Patch applied.
Comment 7 Nick Edgar CLA 2005-03-31 09:59:56 EST
Fixed.
Comment 8 Nick Edgar CLA 2005-06-13 13:28:23 EDT
Verified in 3.1 RC2.