Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 315492 - [IDE] WorkspaceModifyOperation class javadoc may mislead with statement about "if no scheduling rule is provided"
Summary: [IDE] WorkspaceModifyOperation class javadoc may mislead with statement about...
Status: CLOSED WONTFIX
Alias: None
Product: Platform
Classification: Eclipse Project
Component: IDE (show other bugs)
Version: 3.6   Edit
Hardware: PC Windows 7
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Platform UI Triaged CLA
QA Contact:
URL:
Whiteboard: stalebug
Keywords:
Depends on:
Blocks:
 
Reported: 2010-06-02 16:30 EDT by Eddie Galvez CLA
Modified: 2021-09-22 15:14 EDT (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Eddie Galvez CLA 2010-06-02 16:30:37 EDT
Build Identifier: 3.5.2

WMO class javadoc reads, in part:

 * <p>
 * If a scheduling rule is provided, the operation will obtain that scheduling
 * rule for the duration of its <code>execute</code> method.  If no scheduling
 * rule is provided, the operation will obtain a scheduling rule that locks
 * the entire workspace for the duration of the operation.
 * </p>

What might want to get clarified, is that:
 (1) the no-argument constructor will use a rule that locks the entire workspace
 (2) the argument taking an ISchedulingRule accepts null, to mean NO scheduling rule.

In particular, I read the class javadoc to mean that passing in null (to the argument that takes an ISchedulingRule) would result in a workspace-lock.

To re-iterate the changes requested:

1) the no-argument constructor should say "Creates a new operation with a scheduling rule that locks the entire workspace"
2) the class javadoc paragraph shown above should read:

 * <p>
 * If a scheduling rule is provided by invoking the single-argument constructor, the operation will obtain that scheduling
 * rule (which may be null) for the duration of its <code>execute</code> method.  Subclasses that
 * invoke the no-argument constructor will use a scheduling rule that locks
 * the entire workspace for the duration of the operation.
 * </p>

Reproducible: Always
Comment 1 Eclipse Webmaster CLA 2019-09-06 16:08:34 EDT
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.
Comment 2 Eclipse Genie CLA 2021-09-22 15:14:03 EDT
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. As such, we're closing this bug.

If you have further information on the current state of the bug, please add it and reopen this bug. 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.

--
The automated Eclipse Genie.