1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-04 06:45:43 +02:00

adding @since tags for new apis

This commit is contained in:
David McKnight 2008-04-03 14:32:06 +00:00
parent 5eae7cb272
commit 67af0c4217
3 changed files with 19 additions and 0 deletions

View file

@ -50,6 +50,7 @@ public interface ISystemMountPathMapper
* @param subsystem the remote file subsystem. User the subsystem to customize how the temp file is located. If null * @param subsystem the remote file subsystem. User the subsystem to customize how the temp file is located. If null
* is specified, then the subsystem is not used in determining the mapping * is specified, then the subsystem is not used in determining the mapping
* @return the corresponding workspace replica mapping * @return the corresponding workspace replica mapping
* @since 3.0
*/ */
public String getWorkspaceMappingFor(String hostname, String remotePath, IRemoteFileSubSystem subsystem); public String getWorkspaceMappingFor(String hostname, String remotePath, IRemoteFileSubSystem subsystem);
@ -85,6 +86,7 @@ public interface ISystemMountPathMapper
* @param remotePath the remote path as seen by the file subsystem * @param remotePath the remote path as seen by the file subsystem
* @param subsystem the remote file subsystem * @param subsystem the remote file subsystem
* @return whether this mapper handles remapping of the specified remote resource * @return whether this mapper handles remapping of the specified remote resource
* @since 3.0
*/ */
public boolean handlesMappingFor(String hostname, String remotePath, IRemoteFileSubSystem subsystem); public boolean handlesMappingFor(String hostname, String remotePath, IRemoteFileSubSystem subsystem);

View file

@ -216,6 +216,7 @@ public class UniversalFileTransferUtility
* @param srcFileOrFolder the file to copy * @param srcFileOrFolder the file to copy
* @param monitor the progress monitor * @param monitor the progress monitor
* @return the resulting local replica * @return the resulting local replica
* @since 3.0
*/ */
protected static IFile downloadFileToWorkspace(IRemoteFile srcFileOrFolder, IProgressMonitor monitor) protected static IFile downloadFileToWorkspace(IRemoteFile srcFileOrFolder, IProgressMonitor monitor)
{ {
@ -344,6 +345,7 @@ public class UniversalFileTransferUtility
* @param remoteFile * @param remoteFile
* @param hostname * @param hostname
* @param userId * @param userId
* @since 3.0
*/ */
protected static void setIFileProperties(IFile tempFile, File remoteFile, String hostname, String userId) protected static void setIFileProperties(IFile tempFile, File remoteFile, String hostname, String userId)
{ {
@ -389,6 +391,7 @@ public class UniversalFileTransferUtility
* @param remoteSet the set of resources to download * @param remoteSet the set of resources to download
* @param monitor the progress monitor * @param monitor the progress monitor
* @return the set of temporary files created as a result of the download. * @return the set of temporary files created as a result of the download.
* @since 3.0
*/ */
public static SystemWorkspaceResourceSet downloadResourcesToWorkspaceMultiple(SystemRemoteResourceSet remoteSet, IProgressMonitor monitor) public static SystemWorkspaceResourceSet downloadResourcesToWorkspaceMultiple(SystemRemoteResourceSet remoteSet, IProgressMonitor monitor)
{ {
@ -764,6 +767,9 @@ public class UniversalFileTransferUtility
} }
} }
/**
* @since 3.0
*/
public static Object downloadResourceToWorkspace(File srcFileOrFolder, IProgressMonitor monitor) { public static Object downloadResourceToWorkspace(File srcFileOrFolder, IProgressMonitor monitor) {
if (!srcFileOrFolder.exists()) { if (!srcFileOrFolder.exists()) {
@ -1239,6 +1245,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 resulting remote objects * @return the resulting remote objects
* @since 3.0
*/ */
public static SystemRemoteResourceSet uploadResourcesFromWorkspace(SystemWorkspaceResourceSet workspaceSet, IRemoteFile targetFolder, IProgressMonitor monitor, boolean checkForCollisions) public static SystemRemoteResourceSet uploadResourcesFromWorkspace(SystemWorkspaceResourceSet workspaceSet, IRemoteFile targetFolder, IProgressMonitor monitor, boolean checkForCollisions)
{ {
@ -1824,6 +1831,9 @@ public class UniversalFileTransferUtility
return result; return result;
} }
/**
* @since 3.0
*/
public static void compressedUploadFromWorkspace(IContainer directory, IRemoteFile newTargetFolder, IProgressMonitor monitor) throws Exception public static void compressedUploadFromWorkspace(IContainer directory, IRemoteFile newTargetFolder, IProgressMonitor monitor) throws Exception
{ {
if (!newTargetFolder.getParentRemoteFileSubSystem().getParentRemoteFileSubSystemConfiguration().supportsArchiveManagement()) return; if (!newTargetFolder.getParentRemoteFileSubSystem().getParentRemoteFileSubSystemConfiguration().supportsArchiveManagement()) return;
@ -2463,6 +2473,9 @@ public class UniversalFileTransferUtility
return false; return false;
} }
/**
* @since 3.0
*/
protected static String getWorkspaceRemotePath(IRemoteFileSubSystem subsystem, String remotePath) { protected static String getWorkspaceRemotePath(IRemoteFileSubSystem subsystem, String remotePath) {
if (subsystem != null) { if (subsystem != null) {
@ -2472,6 +2485,9 @@ public class UniversalFileTransferUtility
return remotePath; return remotePath;
} }
/**
* @since 3.0
*/
protected static String getWorkspaceRemotePath(String hostname, String remotePath, IRemoteFileSubSystem subsystem) { protected static String getWorkspaceRemotePath(String hostname, String remotePath, IRemoteFileSubSystem subsystem) {
return SystemRemoteEditManager.getInstance().getWorkspacePathFor(hostname, remotePath, subsystem); return SystemRemoteEditManager.getInstance().getWorkspacePathFor(hostname, remotePath, subsystem);
} }

View file

@ -64,6 +64,7 @@ public interface ISystemFileTransferModeMapping {
/** /**
* Gets the priority - the smaller the number, the higher priority * Gets the priority - the smaller the number, the higher priority
* @return the priority * @return the priority
* @since 3.0
*/ */
public int getPriority(); public int getPriority();
} }