mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-21 23:33:57 +02:00
Code Issues Wiki Activity

Improve Javadoc of IHostFile#getFile()

Browse source
This commit is contained in:
Martin Oberhuber 2007-07-27 17:14:55 +00:00
parent 9aea36c02e
commit 17795ab579
2 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
rse/plugins/org.eclipse.rse.services.ssh/src/org/eclipse/rse/internal/services/ssh/files/SftpFileService.java
View file

@ -245,9 +245,10 @@ public class SftpFileService extends AbstractFileService implements IFileService
public IHostFile getFile(String remoteParent, String fileName, IProgressMonitor monitor) throws SystemMessageException public IHostFile getFile(String remoteParent, String fileName, IProgressMonitor monitor) throws SystemMessageException
{ {
//TODO getFile() must return a dummy even for non-existent files, //getFile() must return a dummy even for non-existent files,
//or the move() operation will fail. This needs to be described in //or the move() operation will fail. This is described in
//the API docs. //the API docs.
//TODO when monitor is canceled, it is unclear whether we should return an empty file node or throw a canceled exception.
SftpHostFile node = null; SftpHostFile node = null;
SftpATTRS attrs = null; SftpATTRS attrs = null;
if (fDirChannelMutex.waitForLock(monitor, fDirChannelTimeout)) { if (fDirChannelMutex.waitForLock(monitor, fDirChannelTimeout)) {

5
rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/IFileService.java
View file

@ -94,7 +94,10 @@ public interface IFileService extends IService
* @param remoteParent * @param remoteParent
* @param name * @param name
* @param monitor the monitor for this potentially long running operation * @param monitor the monitor for this potentially long running operation
* @return the host file given the parent path and file name * @return the host file given the parent path and file name.
* Must not return <code>null</code>, non-existing files should be
* reported with an IHostFile object where {@link IHostFile#exists()}
* returns <code>false</code>.
* @throws SystemMessageException if an error occurs. * @throws SystemMessageException if an error occurs.
* Typically this would be one of those in the RemoteFileException family. * Typically this would be one of those in the RemoteFileException family.
*/ */