1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-19 22:25:52 +02:00

[releng][cleanup] Fix @since tags according to API Tooling

This commit is contained in:
Martin Oberhuber 2008-06-04 08:55:01 +00:00
parent 8c6050dbe2
commit ab9d7e283b
8 changed files with 186 additions and 133 deletions

View file

@ -76,6 +76,10 @@ public abstract class AbstractFileService extends AbstractService implements IFi
protected abstract IHostFile[] internalFetch(String parentPath, String fileFilter, int fileType, IProgressMonitor monitor) throws SystemMessageException; protected abstract IHostFile[] internalFetch(String parentPath, String fileFilter, int fileType, IProgressMonitor monitor) throws SystemMessageException;
/**
* {@inheritDoc}
* @since 3.0
*/
public void getFileMultiple(String remoteParents[], String names[], List hostFiles, IProgressMonitor monitor) public void getFileMultiple(String remoteParents[], String names[], List hostFiles, IProgressMonitor monitor)
throws SystemMessageException throws SystemMessageException
{ {
@ -89,12 +93,20 @@ public abstract class AbstractFileService extends AbstractService implements IFi
} }
} }
/**
* {@inheritDoc}
* @since 3.0 using int fileTYpe
*/
public IHostFile[] list(String remoteParent, String fileFilter, public IHostFile[] list(String remoteParent, String fileFilter,
int fileType, IProgressMonitor monitor) throws SystemMessageException int fileType, IProgressMonitor monitor) throws SystemMessageException
{ {
return internalFetch(remoteParent, fileFilter, fileType, monitor); return internalFetch(remoteParent, fileFilter, fileType, monitor);
} }
/**
* {@inheritDoc}
* @since 3.0
*/
public void listMultiple(String[] remoteParents, public void listMultiple(String[] remoteParents,
String[] fileFilters, int fileTypes[], List hostFiles, IProgressMonitor monitor) String[] fileFilters, int fileTypes[], List hostFiles, IProgressMonitor monitor)
throws SystemMessageException { throws SystemMessageException {
@ -114,6 +126,10 @@ public abstract class AbstractFileService extends AbstractService implements IFi
} }
/**
* {@inheritDoc}
* @since 3.0
*/
public void listMultiple(String[] remoteParents, public void listMultiple(String[] remoteParents,
String[] fileFilters, int fileType, List hostFiles, IProgressMonitor monitor) String[] fileFilters, int fileType, List hostFiles, IProgressMonitor monitor)
throws SystemMessageException { throws SystemMessageException {
@ -163,6 +179,10 @@ public abstract class AbstractFileService extends AbstractService implements IFi
} }
/**
* {@inheritDoc}
* @since 3.0 returning void
*/
public void deleteBatch(String[] remoteParents, String[] fileNames, IProgressMonitor monitor) throws SystemMessageException public void deleteBatch(String[] remoteParents, String[] fileNames, IProgressMonitor monitor) throws SystemMessageException
{ {
if (monitor != null) if (monitor != null)
@ -176,7 +196,8 @@ public abstract class AbstractFileService extends AbstractService implements IFi
} }
/** /**
* Default implementation - just iterate through each file * {@inheritDoc} Default implementation - just iterate through each file
* @since 3.0 returning void
*/ */
public void downloadMultiple(String[] remoteParents, String[] remoteFiles, public void downloadMultiple(String[] remoteParents, String[] remoteFiles,
File[] localFiles, boolean[] isBinaries, String[] hostEncodings, File[] localFiles, boolean[] isBinaries, String[] hostEncodings,
@ -198,7 +219,8 @@ public abstract class AbstractFileService extends AbstractService implements IFi
} }
/** /**
* Default implementation - just iterate through each file * {@inheritDoc} Default implementation - just iterate through each file
* @since 3.0
*/ */
public void uploadMultiple(File[] localFiles, String[] remoteParents, public void uploadMultiple(File[] localFiles, String[] remoteParents,
String[] remoteFiles, boolean[] isBinaries, String[] srcEncodings, String[] remoteFiles, boolean[] isBinaries, String[] srcEncodings,
@ -253,10 +275,13 @@ public abstract class AbstractFileService extends AbstractService implements IFi
} }
/** /**
* Gets the output stream to write/append to a remote file. * Gets the output stream to write/append to a remote file. The default
* The default implementation returns <code>null</code>. * implementation returns <code>null</code>. Clients can override to return
* Clients can override to return an output stream to the file. * an output stream to the file.
* @see org.eclipse.rse.services.files.IFileService#getOutputStream(String, String, int, IProgressMonitor) *
* @see org.eclipse.rse.services.files.IFileService#getOutputStream(String,
* String, int, IProgressMonitor)
* @since 3.0 using int options
*/ */
public OutputStream getOutputStream(String remoteParent, String remoteFile, int options, IProgressMonitor monitor) throws SystemMessageException { public OutputStream getOutputStream(String remoteParent, String remoteFile, int options, IProgressMonitor monitor) throws SystemMessageException {
if ((options & IFileService.APPEND) == 0) { if ((options & IFileService.APPEND) == 0) {
@ -268,8 +293,10 @@ public abstract class AbstractFileService extends AbstractService implements IFi
} }
/** /**
* The default implementation returns false. Clients should override this method if they make use * The default implementation returns false. Clients should override this
* of IFileServiceCodePageConverter to do conversion during download and upload. * method if they make use of IFileServiceCodePageConverter to do conversion
* during download and upload.
* @since 3.0
*/ */
public boolean supportsEncodingConversion(){ public boolean supportsEncodingConversion(){
return false; return false;

View file

@ -19,7 +19,10 @@ package org.eclipse.rse.services.files;
import java.util.Vector; import java.util.Vector;
/** /**
* Utility class for getting a file service code page converter for a given server encoding and file service * Utility class for getting a file service code page converter for a given
* server encoding and file service
*
* @since 3.0
*/ */
public class CodePageConverterManager { public class CodePageConverterManager {

View file

@ -19,6 +19,9 @@ import java.io.File;
import java.io.FileInputStream; import java.io.FileInputStream;
import java.io.FileOutputStream; import java.io.FileOutputStream;
/**
* @since 3.0
*/
public class DefaultFileServiceCodePageConverter implements public class DefaultFileServiceCodePageConverter implements
IFileServiceCodePageConverter { IFileServiceCodePageConverter {

View file

@ -14,8 +14,8 @@
package org.eclipse.rse.services.files; package org.eclipse.rse.services.files;
/** /**
* Implementation of IHostFilePermissions. * Default implementation of "Universal" UNIX kind of IHostFilePermissions.
* * @since 3.0
*/ */
public class HostFilePermissions implements public class HostFilePermissions implements
IHostFilePermissions, Cloneable { IHostFilePermissions, Cloneable {
@ -26,8 +26,8 @@ public class HostFilePermissions implements
/** /**
* Constructor without any intial values. Users of this * Constructor without any initial values. Users of this need to set fields
* need to set fields as appropriate * as appropriate
*/ */
public HostFilePermissions(){ public HostFilePermissions(){
} }

View file

@ -18,7 +18,12 @@ import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.rse.services.clientserver.messages.SystemMessageException; import org.eclipse.rse.services.clientserver.messages.SystemMessageException;
/** /**
* Service used to get and set the permissions of a file. * Service used to get and set the permissions of a file. The
* {@link #getCapabilities(IHostFile)} method must be implemented to tell
* clients what kinds of permission services are actually available on a
* concrete implementation.
*
* @since 3.0
*/ */
public interface IFilePermissionsService { public interface IFilePermissionsService {

View file

@ -14,6 +14,13 @@
package org.eclipse.rse.services.files; package org.eclipse.rse.services.files;
/**
* Interface for file permission and ownership support in RSE
* IFileService. An implementation of an IHostFilePermissions
* object is expected to be a data storage for permission and
* ownership information.
* @since 3.0
*/
public interface IHostFilePermissions { public interface IHostFilePermissions {
/** /**

View file

@ -14,9 +14,9 @@
package org.eclipse.rse.services.files; package org.eclipse.rse.services.files;
/** /**
* A container of permissions. Implementations of IHostFile that support * A container of permissions. Implementations of IHostFile that support
* IHostFilePermissions should implement this too * IHostFilePermissions should implement this too
* * @since 3.0
*/ */
public interface IHostFilePermissionsContainer { public interface IHostFilePermissionsContainer {

View file

@ -13,6 +13,14 @@
********************************************************************************/ ********************************************************************************/
package org.eclipse.rse.services.files; package org.eclipse.rse.services.files;
/**
* A dummy HostFilePermissions node that can be used for deferred
* query of permissions. Clients who want to read permissions but
* see this pending node need to wait until the real permissions
* get available.
*
* @since 3.0
*/
public class PendingHostFilePermissions extends HostFilePermissions { public class PendingHostFilePermissions extends HostFilePermissions {
public PendingHostFilePermissions() public PendingHostFilePermissions()