Fixed spelling, grammar in javadoc

2 files changed, 39 insertions, 40 deletions

diff --git a/bundles/org.eclipse.equinox.frameworkadmin/src/org/eclipse/equinox/frameworkadmin/FrameworkAdmin.java b/bundles/org.eclipse.equinox.frameworkadmin/src/org/eclipse/equinox/frameworkadmin/FrameworkAdmin.java
index 91ccf0fbf..b50c71d3b 100644
--- a/bundles/org.eclipse.equinox.frameworkadmin/src/org/eclipse/equinox/frameworkadmin/FrameworkAdmin.java
+++ b/bundles/org.eclipse.equinox.frameworkadmin/src/org/eclipse/equinox/frameworkadmin/FrameworkAdmin.java
@@ -20,20 +20,21 @@ import java.io.IOException;
  * *****************************************************************
  * 1. For developers who implement bundles that register this service.
  * 
- * At the registration, the following 
- *  service properties must be set for client to search the FrameworkAdmin object
- *  which will create BundlesState / ConfigData / LauncherData objects.
+ * Upon registration, the following service properties must be set to allow clients to 
+ * search the FrameworkAdmin object, which will create BundlesState / ConfigData / LauncherData objects.
  * 
  * {@link FrameworkAdmin#SERVICE_PROP_KEY_FW_NAME}: String; name of the framework 
  * {@link FrameworkAdmin#SERVICE_PROP_KEY_FW_VERSION}: String; version of the framework
  * {@link FrameworkAdmin#SERVICE_PROP_KEY_LAUNCHER_NAME}: String; name of the launcher 
  * {@link FrameworkAdmin#SERVICE_PROP_KEY_LAUNCHER_VERSION}: String; version of the launcher 
  *
- * Bundles register this service will check if the currently runnning system can be manipulated by 
+ * Bundles that register this service will check if the currently running system can be manipulated by 
  * this FrameworkAdmin. If yes and this implementation can create an initialized Manipulator object
- * according to the running fw and launcher, add the service property keyed by 
+ * according to the running framework and launcher, add the service property keyed by 
  * 
- * {@link FrameworkAdmin#SERVICE_PROP_KEY_RUNNING_SYSTEM_FLAG}: String; if "true", this service that will be returned by getRunningManipulator() is fully initialized so as to represent the state of running system.
+ * {@link FrameworkAdmin#SERVICE_PROP_KEY_RUNNING_SYSTEM_FLAG}: String; if "true", 
+ * the service that will be returned by getRunningManipulator() is fully initialized to 
+ * represent the state of the running system.
  *     
  * It is recommended to implement Manipulator objects created by calling methods of this interface
  * so that they cannot be used after this service is unregistered.  
@@ -41,24 +42,23 @@ import java.io.IOException;
  * *****************************************************************
  * 2. For developers who implement client bundles that use this service.
  * 
- * A client bundle of this service can get new Manipulator object 
- * by calling its method.
+ * A client of this service can obtain a Manipulator object by calling the {@link #getManipulator()} method.
  * 
- * A client bundle can search among services registered in a service registry
- * and can get the desired FrameworkAdmin service object so that the bundle 
- * can get the desired {@link Manipulator} object for desired framework type with version and launcher type with version.
+ * A client can search among services registered in a service registry to find the 
+ * desired FrameworkAdmin implementation that matches the desired framework 
+ * type, framework version, launcher type, and launcher version.
  * 
- * Especially, in order for a client bundle to manipulate the {@link Manipulator} object of the running fw and laucher,
- * filtering (FrameworkAdmin#SERVICE_PROP_KEY_RUNNING_FW_FLAG=true) is used.   
+ * In order for a client bundle to manipulate the {@link Manipulator} object 
+ * of the running framework and launcher, the service filter (FrameworkAdmin#SERVICE_PROP_KEY_RUNNING_FW_FLAG=true) 
+ * should be used.   
  * 
- * As generally speaking about OSGi service, the client bundle should track this service state.
- * If unregistered, it should stop using any of objects that it got by this service and 
- * release all of them. If it continues to use them, {@link FrameworkAdminRuntimeException} might 
+ * As with all OSGi services, the client bundle should track this service state.
+ * If the service is unregistered, it should stop using any of the objects obtained from this service and 
+ * release them. If it continues to use them, {@link FrameworkAdminRuntimeException} might 
  * be thrown. 
  * 
  * *****************************************************************
- * In addition, FrameworkAdminFactory will creat this object.
- * This is used by Java programs.
+ * In addition, FrameworkAdminFactory will create this object. This is used by Java programs.
  * 
  * @see FrameworkAdminFactory
  *    
@@ -77,7 +77,7 @@ public interface FrameworkAdmin {
 	 * 
 	 * @return new instance of Manipulator.
 	 */
-	Manipulator getManipulator();
+	public Manipulator getManipulator();
 
 	/**
 	 * Create new instance of {@link Manipulator} for running system 
@@ -86,12 +86,11 @@ public interface FrameworkAdmin {
 	 * 
 	 * @return new instance of Manipulator.
 	 */
-	Manipulator getRunningManipulator();
+	public Manipulator getRunningManipulator();
 
 	/**
 	 * Launch a framework instance under the specified current working directory. 
 	 * 
-	 * 
 	 * @param manipulator {@link Manipulator} object to be launched.
 	 * @param cwd current working directory to be used for launching.
 	 * @return process
@@ -100,11 +99,11 @@ public interface FrameworkAdmin {
 	 * @throws FrameworkAdminRuntimeException if the FrameworkAdmin service object
 	 * 		 that created the specified Manipulator object is unregistered.
 	 */
-	Process launch(Manipulator manipulator, File cwd) throws IllegalArgumentException, IOException, FrameworkAdminRuntimeException;
+	public Process launch(Manipulator manipulator, File cwd) throws IllegalArgumentException, IOException, FrameworkAdminRuntimeException;
 
 	/**
 	 * 	
 	 * @return true if this object is active. false otherwise.
 	 */
-	boolean isActive();
+	public boolean isActive();
 }
diff --git a/bundles/org.eclipse.equinox.frameworkadmin/src/org/eclipse/equinox/frameworkadmin/Manipulator.java b/bundles/org.eclipse.equinox.frameworkadmin/src/org/eclipse/equinox/frameworkadmin/Manipulator.java
index d8bcd2c32..a0e1e6378 100644
--- a/bundles/org.eclipse.equinox.frameworkadmin/src/org/eclipse/equinox/frameworkadmin/Manipulator.java
+++ b/bundles/org.eclipse.equinox.frameworkadmin/src/org/eclipse/equinox/frameworkadmin/Manipulator.java
@@ -19,10 +19,10 @@ import org.eclipse.equinox.configuratormanipulator.ConfiguratorManipulator;
  * An object implementing this interface will be gotten by calling 
  * {@link FrameworkAdmin#getManipulator()}. 
  * 
- * The object plays main roles for handling a framwork, such as configuring a framework
+ * The object plays main roles for handling a framework, such as configuring a framework
  * and launching.
  * 
- * The typical usecases of this method:
+ * The typical use-cases of this method:
  * 
  * Usecase 1: set parameters, check the expected state, save them into configuration files, and launch. 
  * 	A. create a {@link Manipulator} object from a {@link FrameworkAdmin}.
@@ -35,7 +35,7 @@ import org.eclipse.equinox.configuratormanipulator.ConfiguratorManipulator;
  * Usecase 2: set parameters required for loading, load parameters from configuration files,
  * 		  check the expected state, and launch. 
  * 	A. create a {@link Manipulator} object from a {@link FrameworkAdmin}.
- *  B. set parameters about launcher or fw config file to the {@link Manipulator} object.
+ *  B. set parameters about launcher or framework configuration file to the {@link Manipulator} object.
  *  C. load parameters from configuration files by {@link Manipulator#load()};
  *  D. getExpectedState() and check what bundle state will be realized.
  *  E. launch the framework by {@link FrameworkAdmin#launch(Manipulator, File)}.
@@ -51,22 +51,22 @@ public interface Manipulator {
 	 * according to the parameters set to this object "in memory".
 	 * 
 	 * None of launcher config file, framework config file and configurator config file
-	 * will be read by this method. However, the fw persistent data location should be
+	 * will be read by this method. However, the framework persistent data location should be
 	 * taken into consideration. In other words, this method will return 
 	 * the expected {@link BundlesState} object assuming that the current parameters were saved and 
 	 * {@link FrameworkAdmin#launch(Manipulator, File)} with an argument of this object 
-	 * were called. (It would read the fw persistent data location if required).
+	 * were called. (It would read the framework persistent data location if required).
 	 *  
 	 * This method should not modify the parameters in this {@link Manipulator} object.
 	 * 
-	 * @return fw bundle state object created according to he current parameters set.
+	 * @return framework bundle state object created according to he current parameters set.
 	 * @throws FrameworkAdminRuntimeException - If the {@link FrameworkAdmin} service created this object is unregistered or this implementation doesn't support this method. 
 	 */
 	BundlesState getBundlesState() throws FrameworkAdminRuntimeException;
 
 	/**
 	 * The reference of {@link ConfigData} object representing configuration information related with framework settings will be returned.
-	 * Remind that manipulating returned object will affect this Manipulator behaivior.
+	 * Remind that manipulating returned object will affect this Manipulator behavior.
 	 *  
 	 * @return ConfigData object representing configuration information related with framework setting 
 	 * @throws FrameworkAdminRuntimeException - If the {@link FrameworkAdmin} service created this object is unregistered or this implementation doesn't support this method. 
@@ -79,11 +79,11 @@ public interface Manipulator {
 	 * according to the parameters set to this object "in memory".
 	 * 
 	 * None of launcher config file, framework config file and configurator config file
-	 * will be read by this method. However, the fw persistent data location should be
+	 * will be read by this method. However, the framework persistent data location should be
 	 * taken into consideration. In other words, this method will return 
 	 * the expected bundles state assuming that the current parameters were saved and 
 	 * {@link FrameworkAdmin#launch(Manipulator, File)} with an argument of this object 
-	 * were called. (It would read the fw persistent data location if required).
+	 * were called. (It would read the framework persistent data location if required).
 	 * 
 	 * Returned BundleInfos must have resolved flag set.
 	 * This method should not modify the parameters in this {@link Manipulator} object. 
@@ -95,7 +95,7 @@ public interface Manipulator {
 	 *  
 	 * @return array of BundleInfo representing expected state of all bundles installed.
 	 * @throws IllegalArgumentException - If either of fwJar or cwd doesn't exist.
-	 * @throws IOException - If reading fw configuration file or reading persitently recorded information 
+	 * @throws IOException - If reading fw configuration file or reading persistently recorded information 
 	 *   of fw fails. 
 	 * @throws FrameworkAdminRuntimeException - If the {@link FrameworkAdmin} service created this object is unregistered or this implementation doesn't support this method. 
 	 */
@@ -104,7 +104,7 @@ public interface Manipulator {
 	/**
 	 * The reference of {@link LauncherData} object representing configuration information
 	 * related with launcher settings will be returned. 
-	 * Remember that manipulating returned object will affect this Manipulator object behaivior.
+	 * Remember that manipulating returned object will affect this Manipulator object behavior.
 	 * 
 	 * @return LauncherData object representing configuration information related with launcher setting 
 	 * @throws FrameworkAdminRuntimeException - If the ManipulatorAdmin service created this object is unregistered or this implementation doesn't support this method. 
@@ -116,7 +116,7 @@ public interface Manipulator {
 	 * Return timestamp of configurations which will be loaded by load() method
 	 * according to the parameters set to this manipulator in long value.
 	 * 
-	 * This method will check last modified time of all laucnher config file, framework config file,
+	 * This method will check last modified time of all launcher configuration file, framework configuration file,
 	 * and framework persistent storage according to the parameters set.
 	 * @return
 	 */
@@ -158,11 +158,11 @@ public interface Manipulator {
 	void load() throws IllegalStateException, IOException, FrameworkAdminRuntimeException;
 
 	/**
-	 * Save parameters that this object keeps at that time into appropriate config files, 
-	 * which include launcher config file, fw config file, and configurator config files
+	 * Save parameters that this object keeps at that time into appropriate configuration files, 
+	 * which include launcher configuration file, framework configuration file, and configurator configuration files
 	 * (if required and implementation of this object supports), according to the current setting and situation. 
 	 * 
-	 * The followins procedure contains the matters of implementation detail.
+	 * The following procedure contains the matters of implementation detail.
 	 * However, it is an example how it works.
 	 * 
 	 * 1. if a launcher file is set,
@@ -177,10 +177,10 @@ public interface Manipulator {
 	 *  
 	 * 3. call {@link ConfiguratorManipulator#save(Manipulator, boolean)} of 
 	 * the ConfiguratorManipulator that can manipulate the chosen ConfiguratorBudnle. 
-	 * This method will save configs for ConfiguratorBundle to read appropriately  
+	 * This method will save configurations for ConfiguratorBundle to read appropriately  
 	 * and return BundleInfo[] to be saved in the FwConfigFile, which is determined by the parameters set.
 	 * 
-	 * 4. Save the rerurned BundleInfo[] in the FwConfigFile, which is determined by the parameters set.
+	 * 4. Save the returned BundleInfo[] in the FwConfigFile, which is determined by the parameters set.
 	 * 	   
 	 * @param backup - if true, keep old file by renaming if exists. 
 	 * @throws IOException - If writing info into configuration files fails.