Bug 209680 - [prov] API - NAMESPACE_IU really refers to the id
Summary: [prov] API - NAMESPACE_IU really refers to the id
Status: RESOLVED FIXED
Alias: None
Product: Equinox
Classification: Eclipse Project
Component: Incubator (show other bugs)
Version: 3.4   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.4 M5   Edit
Assignee: John Arthorne CLA
QA Contact:
URL:
Whiteboard:
Keywords: api
Depends on:
Blocks:
 
Reported: 2007-11-13 13:41 EST by Susan McCourt CLA
Modified: 2008-01-02 17:39 EST (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Susan McCourt CLA 2007-11-13 13:41:37 EST
I figured that the NAMESPACE_IU namespace probably referred to an IU's id, but the documentation surrounding this namespace doesn't make this clear.  I realize there are places where the generic "name" parameter makes sense when providing a value for any random namespace, but when working specifically with NAMESPACE_IU, we should make it clearer that the id is the name used in this namespace.

Examples in the javadoc that are misleading:

* from NAMESPACE_IU
A capability namespace representing a particular InstallableUnit by name.

* public static RequiredCapability createRequiredCapabilityForName(String name, VersionRange versionRange, boolean optional) {...

Even if the constant name NAMESPACE_IU stays the same, we should make sure the arguments for anything that specifically assigns a value to this namespace should be called "id."  Even better, NAMESPACE_IU_ID would be a better name for this namespace.
Comment 1 John Arthorne CLA 2007-12-13 17:17:02 EST
A good one to do during a quiet week
Comment 2 John Arthorne CLA 2008-01-02 17:39:52 EST
Renamed to NAMESPACE_IU_ID, and clarified in the javadoc that it refers to the id of the IU.