Bug 212403 - [api][breaking] SubSystem#internalConnect() should not be API, and fix docs of SubSystem#getConnectorService()
Summary: [api][breaking] SubSystem#internalConnect() should not be API, and fix docs o...
Status: RESOLVED FIXED
Alias: None
Product: Target Management
Classification: Tools
Component: RSE (show other bugs)
Version: 2.0   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 3.0 M4   Edit
Assignee: David McKnight CLA
QA Contact: Martin Oberhuber CLA
URL:
Whiteboard:
Keywords: api
Depends on:
Blocks:
 
Reported: 2007-12-10 09:18 EST by Martin Oberhuber CLA
Modified: 2007-12-11 11:06 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 Martin Oberhuber CLA 2007-12-10 09:18:02 EST 
API docs of SubSystem#getConnectorService() are clearly outdated, because they talk about a SystemManager which does not exist, and the code does not relate to the statement about default implementation.

API docs should be fixed.
Comment 1 Martin Oberhuber CLA 2007-12-10 09:19:43 EST 
Also, review SubSystem#internalConnect().
API Docs say "DO NOT OVERRIDE THIS." but why is it then protected and not final?
Comment 2 David McKnight CLA 2007-12-11 10:19:51 EST 
I've modified the api docs for getConnectorService() and internalConnect().  I've also made internal connect private now since I see no reason for it to be protected.
Comment 3 Martin Oberhuber CLA 2007-12-11 11:06:51 EST 
Making SubSystem#internalConnect() private is a breaking API change - tagging the bug as such. There should not be any clients affected by this, though, since the Javadoc had always forbidden overriding internalConnect().

BTW, do we really want class SubSystem#ConnectJob public?