Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 241532 - incorrect javadoc for IRemoteProcess
Summary: incorrect javadoc for IRemoteProcess
Status: RESOLVED FIXED
Alias: None
Product: PTP
Classification: Tools
Component: Remote Tools (show other bugs)
Version: 2.1M2   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Daniel Felix Ferber CLA
QA Contact: Greg Watson CLA
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-07-21 09:47 EDT by Chris Recoskie CLA
Modified: 2011-05-14 06:36 EDT (History)
0 users

See Also:

Attachments
proposed patch (1.21 KB, patch)
2008-07-21 09:48 EDT, Chris Recoskie CLA 		g.watson: iplog+
Details | Diff
View All 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 Chris Recoskie CLA 2008-07-21 09:47:23 EDT 
The javadoc for IRemoteProcess says that getInputStream() gives you the process's stdin, and that getOutputStream() gives you the stdout.  However this does not make sense, as getInputStream() returns an InputStream (which you cannot write to), and getOutputStream() returns an OutputStream (which you cannot read from).  This would mean that you couldn't communicate with the process at all.

getErrorStream() returns an InputStream, as it should.

I talked to Daniel and he said that the API names (since we are trying to match java.lang.Process) are fixed, but that the javadoc is incorrect.  I am attaching a patch which fixes this.
Comment 1 Chris Recoskie CLA 2008-07-21 09:48:38 EDT 
Created attachment 107941 [details]
proposed patch

proposed patch
Comment 2 Greg Watson CLA 2008-07-21 10:12:43 EDT 
Committed.