[cleanup] format and remove javadoc warnings

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPool.java

@@ -15,10 +15,10 @@
  ********************************************************************************/
 
 package org.eclipse.rse.core.filters;
+
 import org.eclipse.rse.core.model.IRSEModelObject;
 import org.eclipse.rse.core.references.IRSEPersistableReferencedObject;
 
-
 /**
  * This interface represents a system filter pool, which is a means of
  * grouping filters.<br>
@@ -28,31 +28,35 @@ import org.eclipse.rse.core.references.IRSEPersistableReferencedObject;
 /**
  * @lastgen interface SystemFilterPool extends SystemPersistableReferencedObject, SystemFilterContainer {}
  */
-public interface ISystemFilterPool extends IRSEPersistableReferencedObject, ISystemFilterContainer, IRSEModelObject 
+public interface ISystemFilterPool extends IRSEPersistableReferencedObject, ISystemFilterContainer, IRSEModelObject {
-{
 	// external methods
 	/**
 	 * Return the caller which instantiated the filter pool manager overseeing this filter framework instance
 	 */
 	public ISystemFilterPoolManagerProvider getProvider();
+
 	/**
 	 * Set the naming policy used when saving data to disk.
 	 * @see org.eclipse.rse.core.filters.IRSEFilterNamingPolicy
 	 */
 	public void setNamingPolicy(IRSEFilterNamingPolicy namingPolicy);
+
 	/**
 	 * Get the naming policy currently used when saving data to disk.
 	 * @see org.eclipse.rse.core.filters.IRSEFilterNamingPolicy
 	 */
 	public IRSEFilterNamingPolicy getNamingPolicy();
+
 	/**
 	 * Does this filter support nested filters?
 	 */
 	public boolean supportsNestedFilters();
+
 	/**
 	 * Does this support duplicate filter strings? Calls mof-generated isSupportsDuplicateFilterStrings.
 	 */
 	public boolean supportsDuplicateFilterStrings();
+
 	/**
 	 * @return The value of the StringsCaseSensitive attribute
 	 * Are filter strings in this filter case sensitive?
@@ -64,18 +68,22 @@ public interface ISystemFilterPool extends IRSEPersistableReferencedObject, ISys
 	 * Set the filter pool manager.
 	 */
 	public void setSystemFilterPoolManager(ISystemFilterPoolManager mgr);
+
 	/**
 	 * Return the filter pool manager managing this collection of filter pools and their filters.
 	 */
 	public ISystemFilterPoolManager getSystemFilterPoolManager();
+
 	/**
 	 * This is to set transient data that is queryable via getFilterPoolData
 	 */
 	public void setSystemFilterPoolData(Object data);
+
 	/**
 	 * Return transient data set via setFilterPoolData.
 	 */
 	public Object getSystemFilterPoolData();
+
 	/**
 	 * Clone this filter pools' attributes and filters into another filter pool.
 	 * Assumes the core attributes were already set when filter pool was created:
@@ -92,13 +100,13 @@ public interface ISystemFilterPool extends IRSEPersistableReferencedObject, ISys
 	 *   <li>Default
 	 * </ul>
 	 */
-    public void cloneSystemFilterPool(ISystemFilterPool targetPool)
+	public void cloneSystemFilterPool(ISystemFilterPool targetPool) throws Exception;
-           throws Exception;
+
 	/**
 	 * Copy a system filter to this or another filter pool.
 	 */
-    public ISystemFilter copySystemFilter(ISystemFilterPool targetPool, ISystemFilter oldFilter, String newName)
+	public ISystemFilter copySystemFilter(ISystemFilterPool targetPool, ISystemFilter oldFilter, String newName) throws Exception;
-           throws Exception;
+
 	/**
 	 * Order filters according to user preferences.
 	 * <p>
@@ -109,6 +117,7 @@ public interface ISystemFilterPool extends IRSEPersistableReferencedObject, ISys
 	 * Called by someone after restore.
 	 */
 	public void orderSystemFilters(String[] names);
+
 	/**
 	 * Set the save file policy. See constants in SystemFilterConstants. One of:
 	 * <ul>
@@ -119,7 +128,6 @@ public interface ISystemFilterPool extends IRSEPersistableReferencedObject, ISys
 	 */
 	public void setSavePolicy(int policy);
 
-	
 	public String getId();
 
 	/**
@@ -128,7 +136,6 @@ public interface ISystemFilterPool extends IRSEPersistableReferencedObject, ISys
 	 */
 	String getName();
 
-
 	/**
 	 * @generated This field/method will be replaced during code generation 
 	 * @param value The new value of the Name attribute
@@ -247,9 +254,6 @@ public interface ISystemFilterPool extends IRSEPersistableReferencedObject, ISys
 	 * @see #isSetSingleFilterStringOnly()
 	 * @see #unsetSingleFilterStringOnly()
 	 * @see #setSingleFilterStringOnly(boolean)
-	 * @see org.eclipse.rse.filters.FiltersPackage#getSystemFilterPool_SingleFilterStringOnly()
-	 * @model unsettable="true"
-	 * @generated
 	 */
 	boolean isSingleFilterStringOnly();
 
@@ -298,9 +302,6 @@ public interface ISystemFilterPool extends IRSEPersistableReferencedObject, ISys
 	 * <!-- end-user-doc -->
 	 * @return the value of the '<em>Owning Parent Name</em>' attribute.
 	 * @see #setOwningParentName(String)
-	 * @see org.eclipse.rse.filters.FiltersPackage#getSystemFilterPool_OwningParentName()
-	 * @model 
-	 * @generated
 	 */
 	String getOwningParentName();
 
@@ -324,9 +325,6 @@ public interface ISystemFilterPool extends IRSEPersistableReferencedObject, ISys
 	 * <!-- end-user-doc -->
 	 * @return the value of the '<em>Non Renamable</em>' attribute.
 	 * @see #setNonRenamable(boolean)
-	 * @see org.eclipse.rse.filters.FiltersPackage#getSystemFilterPool_NonRenamable()
-	 * @model 
-	 * @generated
 	 */
 	boolean isNonRenamable();
 
@@ -340,9 +338,5 @@ public interface ISystemFilterPool extends IRSEPersistableReferencedObject, ISys
 	 */
 	void setNonRenamable(boolean value);
 
-	public ISystemFilterPool createSystemFilterPool(
+	public ISystemFilterPool createSystemFilterPool(String name, boolean allowNestedFilters, boolean isDeletable, boolean tryToRestore);
-            String name,
-            boolean allowNestedFilters, 
-            boolean isDeletable,
-            boolean tryToRestore);
 }

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolManager.java

@@ -15,15 +15,12 @@
  ********************************************************************************/
 
 package org.eclipse.rse.core.filters;
+
 import java.util.Vector;
 
 import org.eclipse.rse.core.model.ISystemProfile;
 import org.eclipse.rse.core.persistance.IRSEPersistableContainer;
 
-
-
-
-
 /**
  * A filter pool manager manages filter pools.
  * <p>
@@ -80,8 +77,7 @@ import org.eclipse.rse.core.persistance.IRSEPersistableContainer;
 /** 
  * @lastgen interface SystemFilterPoolManager  {}
  */
-public interface ISystemFilterPoolManager extends IRSEPersistableContainer
+public interface ISystemFilterPoolManager extends IRSEPersistableContainer {
-{		
 	// ---------------------------------
 	// ATTRIBUTE METHODS
 	// ---------------------------------
@@ -105,17 +101,19 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * This is to set transient data that is subsequently queryable.
 	 */
 	public void setSystemFilterPoolManagerData(Object data);
+
 	/**
 	 * Return transient data set via setFilterPoolDataManager.
 	 */
 	public Object getSystemFilterPoolManagerData();
+
 	/**
 	 * Return the name of this manager.
 	 * This matches the name of the folder, which is the parent of the individual filter pool folders.
 	 */
 	public String getName();
 
-/**
+	/**
 	 * Set the name of this manager.
 	 */
 	public void setName(String name);
@@ -124,10 +122,12 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * Return attribute indicating if filter pools managed by this manager support nested filters.
 	 */
 	public boolean supportsNestedFilters();
+
 	/**
 	 * Return attribute indicating if filters managed by this manager support nested duplicate filter strings.
 	 */
 	public boolean supportsDuplicateFilterStrings();
+
 	/**
 	 * Set attribute indicating if filter pools managed by this manager support nested filters, by default.
 	 */
@@ -163,6 +163,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * Get array of filter pool names currently existing.
 	 */
 	public String[] getSystemFilterPoolNames();
+
 	/**
 	 * Get vector of filter pool names currently existing.
 	 */
@@ -202,8 +203,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * <p>
 	 * If this operation fails unexpectedly, an exception will be thrown.
 	 */
-    public ISystemFilterPool createSystemFilterPool(String name, boolean isDeletable)
+	public ISystemFilterPool createSystemFilterPool(String name, boolean isDeletable) throws Exception;
-      throws Exception;
 
 	/**
 	 * Delete a given filter pool. Dependending on the save policy, the 
@@ -221,8 +221,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * </ul>
 	 * @param pool The filter pool object to physically delete
 	 */
-    public void deleteSystemFilterPool(ISystemFilterPool pool)
+	public void deleteSystemFilterPool(ISystemFilterPool pool) throws Exception;
-      throws Exception;
 
 	/**
 	 * Delete all existing filter pools. Call this when you are about to delete this manager, say.
@@ -235,6 +234,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * @return true if everything seems ok, false if a file/folder is in use.
 	 */
 	public boolean preTestRenameFilterPool(ISystemFilterPool pool) throws Exception;
+
 	/**
 	 * Rename a given filter pool. Dependending on the save policy, the 
 	 *  appropriate file or folder on disk will also be renamed.
@@ -251,8 +251,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * @param pool The filter pool object to physically rename
 	 * @param newName The new name to give the pool
 	 */
-    public void renameSystemFilterPool(ISystemFilterPool pool, String newName)
+	public void renameSystemFilterPool(ISystemFilterPool pool, String newName) throws Exception;
-      throws Exception;
 
 	/**
 	 * Copy the specified filter pool from this manager to this manager or another manager.
@@ -269,8 +268,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * @param newName The new name to give the copied pool
 	 * @return the new copy of the copied system filter pool
 	 */
-    public ISystemFilterPool copySystemFilterPool(ISystemFilterPoolManager targetMgr, ISystemFilterPool pool, String newName)
+	public ISystemFilterPool copySystemFilterPool(ISystemFilterPoolManager targetMgr, ISystemFilterPool pool, String newName) throws Exception;
-      throws Exception;
 
 	/**
 	 * Copy all filter pools from this manager to another manager.
@@ -285,8 +283,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * </ul>
 	 * @param targetMgr The target manager to copy our filter pools to
 	 */
-    public void copySystemFilterPools(ISystemFilterPoolManager targetMgr)
+	public void copySystemFilterPools(ISystemFilterPoolManager targetMgr) throws Exception;
-      throws Exception;
 
 	/**
 	 * Move the specified filter pool from this manager to another manager.
@@ -306,8 +303,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * @param newName The new name to give the moved pool
 	 * @return the new copy of the moved system filter pool
 	 */
-    public ISystemFilterPool moveSystemFilterPool(ISystemFilterPoolManager targetMgr, ISystemFilterPool oldPool, String newName)
+	public ISystemFilterPool moveSystemFilterPool(ISystemFilterPoolManager targetMgr, ISystemFilterPool oldPool, String newName) throws Exception;
-      throws Exception;
 
 	// ---------------------------------
 	// FILTER METHODS
@@ -320,9 +316,8 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * @param aliasName The name to give the new filter. Must be unique for this pool.
 	 * @param filterStrings The list of String objects that represent the filter strings.
 	 */
-    public ISystemFilter createSystemFilter(ISystemFilterContainer parent,
+	public ISystemFilter createSystemFilter(ISystemFilterContainer parent, String aliasName, Vector filterStrings) throws Exception;
-                                           String aliasName, Vector filterStrings)
+
-        throws Exception;
 	/**
 	 * Creates a new system filter that is typed.
 	 * Same as {@link #createSystemFilter(ISystemFilterContainer, String, Vector)} but 
@@ -337,9 +332,8 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * @param filterStrings The list of String objects that represent the filter strings.
 	 * @param type The type of this filter
 	 */
-    public ISystemFilter createSystemFilter(ISystemFilterContainer parent,
+	public ISystemFilter createSystemFilter(ISystemFilterContainer parent, String aliasName, Vector filterStrings, String type) throws Exception;
-                                           String aliasName, Vector filterStrings, String type)
+
-        throws Exception;
 	/**
 	 * Creates a new system filter that is typed and promptable
 	 * Same as {@link #createSystemFilter(ISystemFilterContainer, String ,Vector, String)} but 
@@ -355,9 +349,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * @param type The type of this filter
 	 * @param promptable Pass true if this is a promptable filter
 	 */
-    public ISystemFilter createSystemFilter(ISystemFilterContainer parent,
+	public ISystemFilter createSystemFilter(ISystemFilterContainer parent, String aliasName, Vector filterStrings, String type, boolean promptable) throws Exception;
-                                           String aliasName, Vector filterStrings, String type, boolean promptable)
-        throws Exception;
 
 	/**
 	 * Delete an existing system filter.
@@ -369,8 +361,8 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 *   <li>Calls back to provider to inform of the event (filterEventFilterDelete)
 	 * </ul>
 	 */
-    public boolean deleteSystemFilter(ISystemFilter filter)
+	public boolean deleteSystemFilter(ISystemFilter filter) throws Exception;
-                   throws Exception;
+
 	/**
 	 * Renames a filter. This is better than filter.setName(String newName) as it 
 	 *  saves the parent pool to disk.
@@ -383,8 +375,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 *   <li>Calls back to provider to inform of the event (filterEventFilterRenamed)
 	 * </ul>
 	 */
-    public void renameSystemFilter(ISystemFilter filter, String newName)
+	public void renameSystemFilter(ISystemFilter filter, String newName) throws Exception;
-           throws Exception;
 
 	/**
 	 * Updates a filter. This is better than doing it directly as it saves it to disk.
@@ -396,8 +387,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 *   <li>Calls back to provider to inform of the event (filterEventFilterUpdated). Will be two callbacks if the name is changed ((filterEventFilterRenamed)
 	 * </ul>
 	 */
-    public void updateSystemFilter(ISystemFilter filter, String newName, String[] strings)
+	public void updateSystemFilter(ISystemFilter filter, String newName, String[] strings) throws Exception;
-           throws Exception;
 
 	/**
 	 * Sets a filter's type. This is better than calling filter.setType(String) directly as it saves the filter to disk after.
@@ -405,17 +395,15 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * A filter's type is an arbitrary string that is not interpreted or used by the base framework. This
 	 * is for use entirely by tools who wish to support multiple types of filters and be able to launch unique
 	 * actions per type, say.
-     * @param parent The parent which is either a SystemFilterPool or a SystemFilter
+	 * @param filter The parent which is either a SystemFilter
-     * @param type The type of this filter
+	 * @param newType The type of this filter
 	 */
-    public void setSystemFilterType(ISystemFilter filter, String newType)
+	public void setSystemFilterType(ISystemFilter filter, String newType) throws Exception;
-           throws Exception;
 
 	/**
 	 * Copy a system filter to a pool in this or another filter manager.
 	 */
-    public ISystemFilter copySystemFilter(ISystemFilterPool targetPool, ISystemFilter oldFilter, String newName)
+	public ISystemFilter copySystemFilter(ISystemFilterPool targetPool, ISystemFilter oldFilter, String newName) throws Exception;
-           throws Exception;
 
 	/**
 	 * Return the zero-based position of a SystemFilter object within its container
@@ -426,8 +414,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * Move a system filter to a pool in this or another filter manager.
 	 * Does this by first copying the filter, and only if successful, deleting the old copy.
 	 */
-    public ISystemFilter moveSystemFilter(ISystemFilterPool targetPool, ISystemFilter oldFilter, String newName)
+	public ISystemFilter moveSystemFilter(ISystemFilterPool targetPool, ISystemFilter oldFilter, String newName) throws Exception;
-           throws Exception;
 
 	/**
 	 * Move existing filters a given number of positions in the same container.
@@ -440,10 +427,9 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 *   <li>Calls back to provider to inform of the event (filterEventFiltersRePositioned)
 	 * </ul>
 	 * @param filters Array of SystemFilters to move.
-     * @param newPosition new zero-based position for the filters
+	 * @param delta the amount by which to move the filters
 	 */
-    public void moveSystemFilters(ISystemFilter filters[], int delta)
+	public void moveSystemFilters(ISystemFilter filters[], int delta) throws Exception;
-              throws Exception;
 
 	/**
 	 * Order filters according to user preferences.
@@ -470,6 +456,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * </ul>
 	 */
 	public ISystemFilterString addSystemFilterString(ISystemFilter filter, String newString) throws Exception;
+
 	/**
 	 * Insert a new filter string to the given filter's list, at the given zero-based position
 	 * <p>
@@ -481,6 +468,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * </ul>
 	 */
 	public ISystemFilterString addSystemFilterString(ISystemFilter filter, String newString, int position) throws Exception;
+
 	/**
 	 * Remove a filter string from this filter's list, given its SystemFilterString object.
 	 * <p>
@@ -493,6 +481,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * @return true if the given string existed and hence was deleted.
 	 */
 	public boolean removeSystemFilterString(ISystemFilter filter, ISystemFilterString filterString) throws Exception;
+
 	/**
 	 * Delete a filter string from the given filter's list
 	 * <p>
@@ -505,6 +494,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * @return true if given string was found and hence was deleted.
 	 */
 	public boolean removeSystemFilterString(ISystemFilter filter, String oldString) throws Exception;
+
 	/**
 	 * Remove a filter string from the given filter's list, given its zero-based position
 	 * <p>
@@ -517,6 +507,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * @return true if a string existed at the given position and hence was deleted.
 	 */
 	public boolean removeSystemFilterString(ISystemFilter filter, int position) throws Exception;
+
 	/**
 	 * Update a filter string's string vale
 	 * <p>
@@ -528,21 +519,23 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * </ul>
 	 */
 	public void updateSystemFilterString(ISystemFilterString filterString, String newValue) throws Exception;
+
 	/**
 	 * Return the zero-based position of a SystemFilterString object within its filter
 	 */
 	public int getSystemFilterStringPosition(ISystemFilterString filterString);
+
 	/**
 	 * Copy a system filter string to a filter in this or another filter pool manager.
 	 */
-    public ISystemFilterString copySystemFilterString(ISystemFilter targetFilter, ISystemFilterString oldFilterString)
+	public ISystemFilterString copySystemFilterString(ISystemFilter targetFilter, ISystemFilterString oldFilterString) throws Exception;
-           throws Exception;
+
 	/**
 	 * Move a system filter string to a filter in this or another filter pool manager.
 	 * Does this by doing a copy operation, then if successful doing a delete operation.
 	 */
-    public ISystemFilterString moveSystemFilterString(ISystemFilter targetFilter, ISystemFilterString oldFilterString)
+	public ISystemFilterString moveSystemFilterString(ISystemFilter targetFilter, ISystemFilterString oldFilterString) throws Exception;
-           throws Exception;
+
 	/**
 	 * Move existing filter strings a given number of positions in the same filter
 	 * If the delta is negative, they are all moved up by the given amount. If 
@@ -554,10 +547,9 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 *   <li>Calls back to provider to inform of the event (filterEventFilterStringsRePositioned)
 	 * </ul>
 	 * @param filterStrings Array of SystemFilterStrings to move.
-     * @param newPosition new zero-based position for the filter strings
+	 * @param delta the amount by which to move the filters
 	 */
-    public void moveSystemFilterStrings(ISystemFilterString filterStrings[], int delta)
+	public void moveSystemFilterStrings(ISystemFilterString filterStrings[], int delta) throws Exception;
-              throws Exception;
 
 	// -----------------------------------
 	// SUSPEND/RESUME CALLBACKS METHODS...
@@ -567,8 +559,6 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 */
 	public void suspendCallbacks(boolean suspend);
 
- 
-
 	/**
 	 * @generated This field/method will be replaced during code generation 
 	 * @return The value of the SupportsNestedFilters attribute
@@ -615,9 +605,6 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer
 	 * <!-- end-user-doc -->
 	 * @return the value of the '<em>Single Filter String Only</em>' attribute.
 	 * @see #setSingleFilterStringOnly(boolean)
-	 * @see org.eclipse.rse.filters.FiltersPackage#getSystemFilterPoolManager_SingleFilterStringOnly()
-	 * @model 
-	 * @generated
 	 */
 	boolean isSingleFilterStringOnly();