Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 273342 - IChannelContainerAdapter's removeChannel(ID) method should specify that the IChannel will be disposed
Summary: IChannelContainerAdapter's removeChannel(ID) method should specify that the I...
Status: RESOLVED FIXED
Alias: None
Product: ECF
Classification: RT
Component: ecf.core (show other bugs)
Version: 3.0.0   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: ecf.core-inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2009-04-22 16:50 EDT by Remy Suen CLA
Modified: 2009-04-22 17:01 EDT (History)
1 user (show)

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 Remy Suen CLA 2009-04-22 16:50:16 EDT 
Currently, it is not clear that the removed IChannel is supposed to be disposed. The javadoc needs to state this for clarity.
Comment 1 Scott Lewis CLA 2009-04-22 16:55:29 EDT 
Adding suggested javadoc now
Comment 2 Scott Lewis CLA 2009-04-22 17:01:24 EDT 
Enhanced javadoc to IAbstractChannelContainerAdapter.removeChannel(ID):

	/**
	 * Remove channel with given ID.  If the channel is found in the container, the 
	 * enclosing container will call {@link IChannel#dispose()} to dispose the channel 
	 * before returning from this method.
	 * 
	 * @param channelID
	 *            the ID of the channel to remove within this container. Must
	 *            not be <code>null</code>.
	 * @return true if channel found and Removed. False if channel not found
	 *         within container.
	 */

Released documentation to HEAD.  Resolving as Fixed.