From 47f2f1bde5b6bd350dd949f96a0fd68c9de92d80 Mon Sep 17 00:00:00 2001 From: Martin Oberhuber < martin.oberhuber@windriver.com> Date: Wed, 23 Apr 2008 20:01:29 +0000 Subject: [PATCH] [cleanup] Fixing @since tag version --- .../miners/UniversalServerUtilities.java | 49 ++++++++++--------- .../files/IFileServiceCodePageConverter.java | 2 +- 2 files changed, 28 insertions(+), 23 deletions(-) diff --git a/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/UniversalServerUtilities.java b/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/UniversalServerUtilities.java index 97f84965f29..d5d729b4055 100644 --- a/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/UniversalServerUtilities.java +++ b/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/UniversalServerUtilities.java @@ -3,13 +3,13 @@ * This program and the accompanying materials are made available under the terms * of the Eclipse Public License v1.0 which accompanies this distribution, and is * available at http://www.eclipse.org/legal/epl-v10.html - * + * * Initial Contributors: * The following IBM employees contributed to the Remote System Explorer * component that contains this file: David McKnight, Kushal Munir, * Michael Berger, David Dykstal, Phil Coulthard, Don Yantzi, Eric Simpson, * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. - * + * * Contributors: * Noriaki Takatsu (IBM) - [220126] [dstore][api][breaking] Single process server for multiple clients * Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags @@ -23,22 +23,27 @@ import org.eclipse.dstore.core.model.DataStore; /** * Utilities for dstore servers. - * + * * @noextend This class is not intended to be subclassed by clients. * @noinstantiate This class is not intended to be instantiated by clients. */ public class UniversalServerUtilities { - /** - * getUserPreferencesDirectory() - returns directory on IFS where to store user settings - * - * @since org.eclipse.rse.services.dstore 3.0 the DataStore argument was added - */ + /** + * getUserPreferencesDirectory() - returns directory on IFS where to store + * user settings. + * + * The dataStore argument was added in version 3.0 in order to support + * multiple clients in separate Threads each. Before that version, the + * method did not have any argument. + * + * @since org.eclipse.rse.services.dstore 3.0 + */ public static String getUserPreferencesDirectory(DataStore dataStore) { - String userPreferencesDirectory = dataStore.getClient().getProperty("user.home"); //$NON-NLS-1$ - + String userPreferencesDirectory = dataStore.getClient().getProperty("user.home"); //$NON-NLS-1$ + String clientUserID = System.getProperty("client.username"); //$NON-NLS-1$ if (clientUserID == null || clientUserID.equals("")) //$NON-NLS-1$ { @@ -48,30 +53,30 @@ public class UniversalServerUtilities { { clientUserID += File.separator; } - + // append a '/' if not there - if ( userPreferencesDirectory.length() == 0 || + if ( userPreferencesDirectory.length() == 0 || userPreferencesDirectory.charAt( userPreferencesDirectory.length() -1 ) != File.separatorChar ) { - + userPreferencesDirectory = userPreferencesDirectory + File.separator; } - + userPreferencesDirectory = userPreferencesDirectory + ".eclipse" + File.separator + //$NON-NLS-1$ "RSE" + File.separator + clientUserID; //$NON-NLS-1$ File dirFile = new File(userPreferencesDirectory); if (!dirFile.exists()) { dirFile.mkdirs(); } - + return userPreferencesDirectory; } - - + + /** * logInfo - * + * * @param minerName - * + * * @param message Message text to be logged. * @since org.eclipse.rse.services.dstore 3.0 */ @@ -82,7 +87,7 @@ public class UniversalServerUtilities { /** * logWarning - * + * * @param minerName * @param message Message text to be logged. * @since org.eclipse.rse.services.dstore 3.0 @@ -94,7 +99,7 @@ public class UniversalServerUtilities { /** * logError - * + * * @param minerName * @param message Message text to be logged. * @param exception Exception that generated the error. Used to print a @@ -108,7 +113,7 @@ public class UniversalServerUtilities { /** * logDebugMessage - * + * * @param minerName * @param message Message text to be logged. * @since org.eclipse.rse.services.dstore 3.0 diff --git a/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/IFileServiceCodePageConverter.java b/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/IFileServiceCodePageConverter.java index 49722e3826d..6f6abd7faaf 100644 --- a/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/IFileServiceCodePageConverter.java +++ b/rse/plugins/org.eclipse.rse.services/src/org/eclipse/rse/services/files/IFileServiceCodePageConverter.java @@ -22,7 +22,7 @@ import java.io.File; * This interface is used by the extension point * It allows overriding the Universal File Subsystem translation of files, and results in * binary transfer, with calls to the implementor to handle code page conversion. - * @since 7.1 + * @since org.eclipse.rse.services 3.0 */ public interface IFileServiceCodePageConverter {