Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 334714

Summary: SapphireCondition migration needs better documentation
Product: z_Archived Reporter: Shenxue Zhou <shenxue.zhou>
Component: SapphireAssignee: Konstantin Komissarchik <konstantin>
Status: CLOSED FIXED QA Contact:
Severity: enhancement    
Priority: P3 CC: konstantin
Version: unspecified   
Target Milestone: ---   
Hardware: All   
OS: All   
Whiteboard:

Description Shenxue Zhou CLA 2011-01-18 16:43:33 EST
Build Identifier: M20100909-0800

In Sapphire 0.2 release, there are a few new classes which extend SapphireCondition. For classes that need to be migrated to extend SapphireModelCondition rather than SapphireCondition, if they contain parameters, they need to override SapphireModelCondition's initCondition() method. But the overridden method need to call super's initCondition() method to ensure that model dependencies and listeners are handled properly.

Failure to do that would result the conditions never re-evaluated when the corresponding model properties change.

We need to add some documentation in regard to this issue in the Sapphire 0.2 migration guide.

Reproducible: Always
Comment 1 Konstantin Komissarchik CLA 2011-01-18 20:10:49 EST
Added some wording about this to the migration guide. Please verify.
Comment 2 Shenxue Zhou CLA 2011-02-02 16:02:37 EST
Just the release doc and found this note:

It is important that any subclass of SapphireModelCondition that overrides initCondition() method, also calls the super implementation of this method. Failing to do that will prevent the condition from refreshing on dependent property changes.
Comment 3 Konstantin Komissarchik CLA 2011-02-24 21:11:53 EST
Closing.