1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-23 08:13:50 +02:00

adding @since tags for new apis

This commit is contained in:
David McKnight 2008-04-03 17:15:02 +00:00
parent 23c50ff530
commit 73ef323898
2 changed files with 38 additions and 0 deletions

View file

@ -1594,6 +1594,7 @@ public class UniversalFileTransferUtility
* @param monitor the progress monitor * @param monitor the progress monitor
* @param checkForCollisions indicates whether to check for colllisions or not * @param checkForCollisions indicates whether to check for colllisions or not
* @return the result remote object * @return the result remote object
* @since 3.0
*/ */
public static Object uploadResourceFromWorkspace(IResource srcFileOrFolder, IRemoteFile targetFolder, IProgressMonitor monitor, boolean checkForCollisions) public static Object uploadResourceFromWorkspace(IResource srcFileOrFolder, IRemoteFile targetFolder, IProgressMonitor monitor, boolean checkForCollisions)
{ {
@ -1992,6 +1993,9 @@ public class UniversalFileTransferUtility
return archiveType; return archiveType;
} }
/**
* @since 3.0
*/
public static IResource compressedDownloadToWorkspace(IRemoteFile directory, IProgressMonitor monitor) throws Exception public static IResource compressedDownloadToWorkspace(IRemoteFile directory, IProgressMonitor monitor) throws Exception
{ {
if (!directory.getParentRemoteFileSubSystem().getParentRemoteFileSubSystemConfiguration().supportsArchiveManagement()) return null; if (!directory.getParentRemoteFileSubSystem().getParentRemoteFileSubSystemConfiguration().supportsArchiveManagement()) return null;
@ -2417,6 +2421,9 @@ public class UniversalFileTransferUtility
} }
/**
* @since 3.0
*/
public static String getActualHostFor(IRemoteFileSubSystem subsystem, String remotePath) public static String getActualHostFor(IRemoteFileSubSystem subsystem, String remotePath)
{ {
String hostname = subsystem.getHost().getHostName(); String hostname = subsystem.getHost().getHostName();
@ -2428,6 +2435,9 @@ public class UniversalFileTransferUtility
return hostname; return hostname;
} }
/**
* @since 3.0
*/
public static String getActualHostFor(String hostname, String remotePath, IRemoteFileSubSystem subsystem) public static String getActualHostFor(String hostname, String remotePath, IRemoteFileSubSystem subsystem)
{ {
return SystemRemoteEditManager.getInstance().getActualHostFor(hostname, remotePath, subsystem); return SystemRemoteEditManager.getInstance().getActualHostFor(hostname, remotePath, subsystem);
@ -2465,6 +2475,9 @@ public class UniversalFileTransferUtility
return false; return false;
} }
/**
* @since 3.0
*/
protected static boolean isRemoteFileMounted(String hostname, String remotePath, IRemoteFileSubSystem subsystem) protected static boolean isRemoteFileMounted(String hostname, String remotePath, IRemoteFileSubSystem subsystem)
{ {
String result = SystemRemoteEditManager.getInstance().getActualHostFor(hostname, remotePath, subsystem); String result = SystemRemoteEditManager.getInstance().getActualHostFor(hostname, remotePath, subsystem);
@ -2550,6 +2563,9 @@ public class UniversalFileTransferUtility
return false; return false;
} }
/**
* @since 3.0
*/
public static class RenameRunnable implements Runnable public static class RenameRunnable implements Runnable
{ {
private IRemoteFile _targetFileOrFolder; private IRemoteFile _targetFileOrFolder;
@ -2557,8 +2573,17 @@ public class UniversalFileTransferUtility
private List _namesInUse = new ArrayList(); private List _namesInUse = new ArrayList();
private int cancelStatus; private int cancelStatus;
/**
* @since 3.0
*/
public static int RENAME_DIALOG_NOT_CANCELED = -1; public static int RENAME_DIALOG_NOT_CANCELED = -1;
/**
* @since 3.0
*/
public static int RENAME_DIALOG_CANCELED = 0; public static int RENAME_DIALOG_CANCELED = 0;
/**
* @since 3.0
*/
public static int RENAME_DIALOG_CANCELED_ALL = 1; public static int RENAME_DIALOG_CANCELED_ALL = 1;
public RenameRunnable(IRemoteFile targetFileOrFolder) public RenameRunnable(IRemoteFile targetFileOrFolder)
@ -2695,6 +2720,7 @@ public class UniversalFileTransferUtility
* @return the set of temp files created as a result of the download. * @return the set of temp files created as a result of the download.
* *
* @deprecated use downloadResourcesToWorkspaceMultiple * @deprecated use downloadResourcesToWorkspaceMultiple
* @since 3.0
*/ */
public static SystemWorkspaceResourceSet copyRemoteResourcesToWorkspaceMultiple(SystemRemoteResourceSet remoteSet, IProgressMonitor monitor) public static SystemWorkspaceResourceSet copyRemoteResourcesToWorkspaceMultiple(SystemRemoteResourceSet remoteSet, IProgressMonitor monitor)
{ {

View file

@ -135,6 +135,7 @@ public interface IRemoteFileSubSystem extends ISubSystem {
* should be exactly one fileType specified per parent. * should be exactly one fileType specified per parent.
* For the default list of available file types see <code>IFileServiceContants</code> * For the default list of available file types see <code>IFileServiceContants</code>
* @param monitor the progress monitor * @param monitor the progress monitor
* @since 3.0
*/ */
public IRemoteFile[] listMultiple(IRemoteFile[] parents, String[] fileNameFilters, int[] fileTypes, IProgressMonitor monitor) throws SystemMessageException; public IRemoteFile[] listMultiple(IRemoteFile[] parents, String[] fileNameFilters, int[] fileTypes, IProgressMonitor monitor) throws SystemMessageException;
@ -145,6 +146,7 @@ public interface IRemoteFileSubSystem extends ISubSystem {
* @param fileType - indicates whether to query files, folders, both or some other type. This fileType is used for each parent query. * @param fileType - indicates whether to query files, folders, both or some other type. This fileType is used for each parent query.
* For the default list of available file types see <code>IFileServiceContants</code> * For the default list of available file types see <code>IFileServiceContants</code>
* @param monitor the progress monitor * @param monitor the progress monitor
* @since 3.0
*/ */
public IRemoteFile[] listMultiple(IRemoteFile[] parents, int fileType, IProgressMonitor monitor) throws SystemMessageException; public IRemoteFile[] listMultiple(IRemoteFile[] parents, int fileType, IProgressMonitor monitor) throws SystemMessageException;
@ -160,6 +162,7 @@ public interface IRemoteFileSubSystem extends ISubSystem {
* {@link IFileService#FILE_TYPE_FOLDERS}, and * {@link IFileService#FILE_TYPE_FOLDERS}, and
* {@link IFileService#FILE_TYPE_FILES_AND_FOLDERS}. * {@link IFileService#FILE_TYPE_FILES_AND_FOLDERS}.
* @param monitor the progress monitor * @param monitor the progress monitor
* @since 3.0
*/ */
public IRemoteFile[] listMultiple(IRemoteFile[] parents, String[] fileNameFilters, int fileType, IProgressMonitor monitor) throws SystemMessageException; public IRemoteFile[] listMultiple(IRemoteFile[] parents, String[] fileNameFilters, int fileType, IProgressMonitor monitor) throws SystemMessageException;
@ -169,6 +172,7 @@ public interface IRemoteFileSubSystem extends ISubSystem {
* *
* @param parent The parent folder to list folders and/or files in * @param parent The parent folder to list folders and/or files in
* @param monitor the progress monitor * @param monitor the progress monitor
* @since 3.0
*/ */
public IRemoteFile[] list(IRemoteFile parent, IProgressMonitor monitor) throws SystemMessageException; public IRemoteFile[] list(IRemoteFile parent, IProgressMonitor monitor) throws SystemMessageException;
@ -181,6 +185,7 @@ public interface IRemoteFileSubSystem extends ISubSystem {
* {@link IFileService#FILE_TYPE_FOLDERS}, and * {@link IFileService#FILE_TYPE_FOLDERS}, and
* {@link IFileService#FILE_TYPE_FILES_AND_FOLDERS}. * {@link IFileService#FILE_TYPE_FILES_AND_FOLDERS}.
* @param monitor the progress monitor * @param monitor the progress monitor
* @since 3.0
*/ */
public IRemoteFile[] list(IRemoteFile parent, int fileType, IProgressMonitor monitor) throws SystemMessageException; public IRemoteFile[] list(IRemoteFile parent, int fileType, IProgressMonitor monitor) throws SystemMessageException;
@ -193,6 +198,7 @@ public interface IRemoteFileSubSystem extends ISubSystem {
* @param fileType - indicates whether to query files, folders, both or some other type. * @param fileType - indicates whether to query files, folders, both or some other type.
* For the default list of available file types see <code>IFileServiceContants</code> * For the default list of available file types see <code>IFileServiceContants</code>
* @param monitor the progress monitor * @param monitor the progress monitor
* @since 3.0
*/ */
public IRemoteFile[] list(IRemoteFile parent, String fileNameFilter, int fileType, IProgressMonitor monitor) throws SystemMessageException; public IRemoteFile[] list(IRemoteFile parent, String fileNameFilter, int fileType, IProgressMonitor monitor) throws SystemMessageException;
@ -207,6 +213,7 @@ public interface IRemoteFileSubSystem extends ISubSystem {
* @param fileType - indicates whether to query files, folders, both or some other type * @param fileType - indicates whether to query files, folders, both or some other type
* For the default list of available file types see <code>IFileServiceContants</code> * For the default list of available file types see <code>IFileServiceContants</code>
* @param monitor the progress monitor * @param monitor the progress monitor
* @since 3.0
*/ */
public IRemoteFile[] list(IRemoteFile parent, String fileNameFilter, IRemoteFileContext context, int fileType, IProgressMonitor monitor) throws SystemMessageException; public IRemoteFile[] list(IRemoteFile parent, String fileNameFilter, IRemoteFileContext context, int fileType, IProgressMonitor monitor) throws SystemMessageException;
@ -268,6 +275,7 @@ public interface IRemoteFileSubSystem extends ISubSystem {
* @param monitor the progress monitor * @param monitor the progress monitor
* *
* @return the set of resources * @return the set of resources
* @since 3.0
*/ */
public IRemoteFile[] getRemoteFileObjects(String[] folderOrFileNames, IProgressMonitor monitor) throws SystemMessageException; public IRemoteFile[] getRemoteFileObjects(String[] folderOrFileNames, IProgressMonitor monitor) throws SystemMessageException;
@ -516,6 +524,7 @@ public interface IRemoteFileSubSystem extends ISubSystem {
* @throws SystemMessageException if an error occurs. * @throws SystemMessageException if an error occurs.
* Typically this would be one of those in the * Typically this would be one of those in the
* {@link RemoteFileException} family. * {@link RemoteFileException} family.
* @since 3.0
*/ */
public void downloadMultiple(IRemoteFile[] sources, String[] destinations, String[] encodings, IProgressMonitor monitor) throws SystemMessageException; public void downloadMultiple(IRemoteFile[] sources, String[] destinations, String[] encodings, IProgressMonitor monitor) throws SystemMessageException;
@ -582,6 +591,7 @@ public interface IRemoteFileSubSystem extends ISubSystem {
* @throws SystemMessageException if an error occurs. * @throws SystemMessageException if an error occurs.
* Typically this would be one of those in the * Typically this would be one of those in the
* {@link RemoteFileException} family. * {@link RemoteFileException} family.
* @since 3.0
*/ */
public void uploadMultiple(String[] sources, IRemoteFile[] destinations, String[] encodings, IProgressMonitor monitor) throws SystemMessageException; public void uploadMultiple(String[] sources, IRemoteFile[] destinations, String[] encodings, IProgressMonitor monitor) throws SystemMessageException;
@ -603,6 +613,7 @@ public interface IRemoteFileSubSystem extends ISubSystem {
* @throws SystemMessageException if an error occurs. * @throws SystemMessageException if an error occurs.
* Typically this would be one of those in the * Typically this would be one of those in the
* {@link RemoteFileException} family. * {@link RemoteFileException} family.
* @since 3.0
*/ */
public void uploadMultiple(String sources[], String[] srcEncodings, String[] remotePaths, String[] rmtEncodings, IProgressMonitor monitor) throws SystemMessageException; public void uploadMultiple(String sources[], String[] srcEncodings, String[] remotePaths, String[] rmtEncodings, IProgressMonitor monitor) throws SystemMessageException;
@ -683,6 +694,7 @@ public interface IRemoteFileSubSystem extends ISubSystem {
* display or enable themselves based on result of this call. * display or enable themselves based on result of this call.
* *
* @return whether this service supports encoding conversion * @return whether this service supports encoding conversion
* @since 3.0
*/ */
public boolean supportsEncodingConversion(); public boolean supportsEncodingConversion();
} }