Bug 25605 - [API] someJavaProject.getRequiredProjectNames(); API should specify that the array is returned in ClassPath order
Summary: [API] someJavaProject.getRequiredProjectNames(); API should specify that the ...
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 2.0.2   Edit
Hardware: PC All
: P3 normal (vote)
Target Milestone: 2.1 M3   Edit
Assignee: Jerome Lanneluc CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2002-10-31 16:35 EST by David J. Orme CLA
Modified: 2002-11-13 07:34 EST (History)
0 users

See Also:

Attachments
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 David J. Orme CLA 2002-10-31 16:35:41 EST 
Given:
IJavaProject someJavaProject = <random but correct initialization>;
String[] myArray = someJavaProject.getRequiredProjectNames(); 

myArray is currently returned in classpath order.  

The current behavior is the behavior I need in order for my plugin to function
properly.

However, the API contract does not specify that myArray will *always* be
returned in classpath order, therefore I cannot currently depend on the current
behavior staying the same.

Since changing the API to reflect current behavior is not a breaking change, I
would like to request that the API be updated to reflect that the array returned
by getRequiredProjectNames() will always be in classpath order.
Comment 1 Philipe Mulet CLA 2002-10-31 17:39:51 EST 
Indeed.
Comment 2 Jerome Lanneluc CLA 2002-11-04 10:00:19 EST 
Changed specification to:
	/**
	 * Returns the names of the projects that are directly required by this
	 * project. A project is required if it is in its classpath.
	 * <p>
	 * The project names are returned in the order they appear on the 
classpath.
	 *
	 * @return the names of the projects that are directly required by this
	 * project in classpath order
	 * @exception JavaModelException if this element does not exist or if an
	 *		exception occurs while accessing its corresponding 
resource
	 */
Comment 3 David J. Orme CLA 2002-11-04 14:00:57 EST 
Thanks!
Comment 4 David Audel CLA 2002-11-13 07:34:48 EST 
Verified.