From 67af0c42178d8fce3aaa49055e2552271b03441b Mon Sep 17 00:00:00 2001 From: David McKnight Date: Thu, 3 Apr 2008 14:32:06 +0000 Subject: [PATCH] adding @since tags for new apis --- .../ui/resources/ISystemMountPathMapper.java | 2 ++ .../resources/UniversalFileTransferUtility.java | 16 ++++++++++++++++ .../model/ISystemFileTransferModeMapping.java | 1 + 3 files changed, 19 insertions(+) diff --git a/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/ISystemMountPathMapper.java b/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/ISystemMountPathMapper.java index dd68c45df84..491113263d1 100644 --- a/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/ISystemMountPathMapper.java +++ b/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/ISystemMountPathMapper.java @@ -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 * is specified, then the subsystem is not used in determining the mapping * @return the corresponding workspace replica mapping + * @since 3.0 */ 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 subsystem the remote file subsystem * @return whether this mapper handles remapping of the specified remote resource + * @since 3.0 */ public boolean handlesMappingFor(String hostname, String remotePath, IRemoteFileSubSystem subsystem); diff --git a/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/UniversalFileTransferUtility.java b/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/UniversalFileTransferUtility.java index 0448de12a8d..0d1cb85f714 100644 --- a/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/UniversalFileTransferUtility.java +++ b/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/UniversalFileTransferUtility.java @@ -216,6 +216,7 @@ public class UniversalFileTransferUtility * @param srcFileOrFolder the file to copy * @param monitor the progress monitor * @return the resulting local replica + * @since 3.0 */ protected static IFile downloadFileToWorkspace(IRemoteFile srcFileOrFolder, IProgressMonitor monitor) { @@ -344,6 +345,7 @@ public class UniversalFileTransferUtility * @param remoteFile * @param hostname * @param userId + * @since 3.0 */ 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 monitor the progress monitor * @return the set of temporary files created as a result of the download. + * @since 3.0 */ 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) { if (!srcFileOrFolder.exists()) { @@ -1239,6 +1245,7 @@ public class UniversalFileTransferUtility * @param monitor the progress monitor * @param checkForCollisions indicates whether to check for colllisions or not * @return the resulting remote objects + * @since 3.0 */ public static SystemRemoteResourceSet uploadResourcesFromWorkspace(SystemWorkspaceResourceSet workspaceSet, IRemoteFile targetFolder, IProgressMonitor monitor, boolean checkForCollisions) { @@ -1824,6 +1831,9 @@ public class UniversalFileTransferUtility return result; } + /** + * @since 3.0 + */ public static void compressedUploadFromWorkspace(IContainer directory, IRemoteFile newTargetFolder, IProgressMonitor monitor) throws Exception { if (!newTargetFolder.getParentRemoteFileSubSystem().getParentRemoteFileSubSystemConfiguration().supportsArchiveManagement()) return; @@ -2463,6 +2473,9 @@ public class UniversalFileTransferUtility return false; } + /** + * @since 3.0 + */ protected static String getWorkspaceRemotePath(IRemoteFileSubSystem subsystem, String remotePath) { if (subsystem != null) { @@ -2472,6 +2485,9 @@ public class UniversalFileTransferUtility return remotePath; } + /** + * @since 3.0 + */ protected static String getWorkspaceRemotePath(String hostname, String remotePath, IRemoteFileSubSystem subsystem) { return SystemRemoteEditManager.getInstance().getWorkspacePathFor(hostname, remotePath, subsystem); } diff --git a/rse/plugins/org.eclipse.rse.subsystems.files.core/src/org/eclipse/rse/subsystems/files/core/model/ISystemFileTransferModeMapping.java b/rse/plugins/org.eclipse.rse.subsystems.files.core/src/org/eclipse/rse/subsystems/files/core/model/ISystemFileTransferModeMapping.java index c752ec557c5..4c5d9931833 100644 --- a/rse/plugins/org.eclipse.rse.subsystems.files.core/src/org/eclipse/rse/subsystems/files/core/model/ISystemFileTransferModeMapping.java +++ b/rse/plugins/org.eclipse.rse.subsystems.files.core/src/org/eclipse/rse/subsystems/files/core/model/ISystemFileTransferModeMapping.java @@ -64,6 +64,7 @@ public interface ISystemFileTransferModeMapping { /** * Gets the priority - the smaller the number, the higher priority * @return the priority + * @since 3.0 */ public int getPriority(); }