From a6e7bc0b7f8f3e5d3c1e9cb77c8f8b83ad91c4e2 Mon Sep 17 00:00:00 2001 From: David Dykstal Date: Tue, 11 Mar 2008 00:19:46 +0000 Subject: [PATCH] [189274] formatting prior to adding new operations for adding filters https://bugs.eclipse.org/bugs/show_bug.cgi?id=189274 --- .../SystemFilterContainerCommonMethods.java | 956 ++++++++---------- 1 file changed, 444 insertions(+), 512 deletions(-) diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/internal/core/filters/SystemFilterContainerCommonMethods.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/internal/core/filters/SystemFilterContainerCommonMethods.java index 06ac72f39ba..e00caace3b6 100644 --- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/internal/core/filters/SystemFilterContainerCommonMethods.java +++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/internal/core/filters/SystemFilterContainerCommonMethods.java @@ -15,6 +15,7 @@ ********************************************************************************/ package org.eclipse.rse.internal.core.filters; + import java.util.Iterator; import java.util.Vector; @@ -23,7 +24,6 @@ import org.eclipse.rse.core.filters.ISystemFilter; import org.eclipse.rse.core.filters.ISystemFilterPool; import org.eclipse.rse.logging.Logger; - /** * This class abstracts out some common code needed by any class that * implements ISystemFilterContainer. @@ -34,537 +34,469 @@ import org.eclipse.rse.logging.Logger; * are stored internally. */ public class SystemFilterContainerCommonMethods - //implements ISystemFilterContainer +//implements ISystemFilterContainer { - private Vector filterNameVector, filterVector; - private ISystemFilter[] filterArray; - + private Vector filterNameVector, filterVector; + private ISystemFilter[] filterArray; + /** * Constructor */ - public SystemFilterContainerCommonMethods() - { + public SystemFilterContainerCommonMethods() { super(); } - - /** - * For performance reasons we have decided to store a cache of the - * filters in vector and array form, so each request will not result - * in a new temporary vector or array. However, this cache can get out - * of date, so this method must be called religiously to invalidate it - * after any change in the filters. - */ - public void invalidateCache() - { - filterNameVector = filterVector = null; - filterArray = null; - } - - /** - * Creates a new system filter within this pool or filter. - * @param filters MOF list of filters the new filter is to be added to. - * @param parentPool pool that contains this filter (directly or indirectly). - * @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(java.util.List filters, - ISystemFilterPool parentPool, - String aliasName, Vector filterStrings) - { - ISystemFilter newFilter = null; - - // FIXME - not using error message and null return - // because I want to restore filters while not being hit with conflicts - newFilter = getSystemFilter(filters, aliasName); - if (newFilter != null) - { - return newFilter; - } - /* DKM - boolean exists = getSystemFilter(filters, aliasName) != null; - if (exists) - { - String msg = "Error creating filter: aliasName " + aliasName + " is not unique"; // no need to xlate, internal only + /** + * For performance reasons we have decided to store a cache of the + * filters in vector and array form, so each request will not result + * in a new temporary vector or array. However, this cache can get out + * of date, so this method must be called religiously to invalidate it + * after any change in the filters. + */ + public void invalidateCache() { + filterNameVector = filterVector = null; + filterArray = null; + } + + /** + * Creates a new system filter within this pool or filter. + * @param filters MOF list of filters the new filter is to be added to. + * @param parentPool pool that contains this filter (directly or indirectly). + * @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(java.util.List filters, ISystemFilterPool parentPool, String aliasName, Vector filterStrings) { + ISystemFilter newFilter = null; + + // FIXME - not using error message and null return + // because I want to restore filters while not being hit with conflicts + newFilter = getSystemFilter(filters, aliasName); + if (newFilter != null) { + return newFilter; + } + /* DKM + boolean exists = getSystemFilter(filters, aliasName) != null; + if (exists) + { + String msg = "Error creating filter: aliasName " + aliasName + " is not unique"; // no need to xlate, internal only RSEUIPlugin.logError(msg); - return null; - } - */ - newFilter = internalCreateSystemFilter(parentPool, aliasName, filterStrings); - if (newFilter != null) - internalAddSystemFilter(filters, newFilter); - return newFilter; - } - /** - * Creates a new system filter within this pool or filter. - * @param filters Vector of filters the new filter is to be added to. - * @param parentPool pool that contains this filter (directly or indirectly) - * @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(Vector filters, - ISystemFilterPool parentPool, - String aliasName, Vector filterStrings) - { - ISystemFilter newFilter = null; - boolean exists = getSystemFilter(filters, aliasName) != null; - if (exists) - { - String msg = "Error creating filter: aliasName " + aliasName + " is not unique"; // no need to xlate, internal only //$NON-NLS-1$ //$NON-NLS-2$ - RSECorePlugin.getDefault().getLogger().logError(msg, null); - return null; - } - newFilter = internalCreateSystemFilter(parentPool, aliasName, filterStrings); - if (newFilter != null) - internalAddSystemFilter(filters, newFilter); - return newFilter; - } - + return null; + } + */ + newFilter = internalCreateSystemFilter(parentPool, aliasName, filterStrings); + if (newFilter != null) internalAddSystemFilter(filters, newFilter); + return newFilter; + } - /** - * Internal encapsulation of mof effort to create new filter, and setting of - * the core attributes. - */ - private ISystemFilter internalCreateSystemFilter( - ISystemFilterPool parentPool, - String aliasName, Vector filterStrings) - { - ISystemFilter newFilter = null; - try - { - newFilter = new SystemFilter(); - // FIXME getMOFfactory().createSystemFilter(); - newFilter.setRelease(RSECorePlugin.CURRENT_RELEASE); - newFilter.setName(aliasName); - newFilter.setParentFilterPool(parentPool); - if (filterStrings != null) - newFilter.setFilterStrings(filterStrings); - //java.util.List filterStringList = newFilter.getFilterStrings(); - //for (int idx=0; idx0); - } - /** - * Return true if there are system filters - */ - public boolean hasSystemFilters(Vector filters) - { - return (filters!=null) && (filters.size()>0); - } + /** + * Return the nested filters as a Vector + */ + public Vector getSystemFiltersVector(Vector filters) { + return filters; + } - - /** - * Return a filter object, given its aliasname. - * Can be used to test if an aliasname is already used (non-null return). - * @param aliasName unique aliasName (case insensitive) to search on. - * @return SystemFilter object with unique aliasName, or null if - * no filter object with this name exists. - */ - public ISystemFilter getSystemFilter(java.util.List filters, String aliasName) - { - ISystemFilter filter = null; - ISystemFilter currFilter = null; - Iterator i = filters.iterator(); - while (i.hasNext() && (filter==null)) - { - currFilter = (ISystemFilter)i.next(); - if (currFilter.getName().equalsIgnoreCase(aliasName)) - filter = currFilter; - } - return filter; - } - /** - * Return a filter object, given its aliasname. - * Can be used to test if an aliasname is already used (non-null return). - * @param aliasName unique aliasName (case insensitive) to search on. - * @return SystemFilter object with unique aliasName, or null if - * no filter object with this name exists. - */ - public ISystemFilter getSystemFilter(Vector filters, String aliasName) - { - if ((filters == null) || (filters.size()==0)) - return null; - ISystemFilter filter = null; - ISystemFilter currFilter = null; - for (int idx=0; (idxPLEASE NOTE: - *
    - *
  • createSystemFilter calls this method for you! - *
  • this is a no-op if a filter with the same aliasname already exists - *
- * @param filter SystemFilter object to add - * @return true if added, false if filter with this aliasname already existed. - */ - public boolean addSystemFilter(java.util.List filters, ISystemFilter filter) - { - boolean exists = getSystemFilter(filters, filter.getName()) != null; - if (!exists) - return internalAddSystemFilter(filters, filter); - else - return false; - } - /** - * Internally, we can skip the uniqueness checking. - */ - protected boolean internalAddSystemFilter(java.util.List filters, ISystemFilter filter) - { - filters.add(filter); - invalidateCache(); - return true; - } - /** - * Adds given filter to the list. - *

PLEASE NOTE: - *

    - *
  • createSystemFilter calls this method for you! - *
  • this is a no-op if a filter with the same aliasname already exists - *
- * @param filter SystemFilter object to add - * @return true if added, false if filter with this aliasname already existed. - */ - public boolean addSystemFilter(Vector filters, ISystemFilter filter) - { - boolean exists = getSystemFilter(filters, filter.getName()) != null; - if (!exists) - return internalAddSystemFilter(filters, filter); - else - return false; - } - /** - * Internally, we can skip the uniqueness checking. - */ - private boolean internalAddSystemFilter(Vector filters, ISystemFilter filter) - { - filters.add(filter); - invalidateCache(); - return true; - } - - + /** + * Return the nested filters as an array + */ + public ISystemFilter[] getSystemFilters(java.util.List filters) { + if ((filterArray == null) || (filterArray.length != filters.size())) { + filterArray = new ISystemFilter[filters.size()]; + Iterator i = filters.iterator(); + int idx = 0; + while (i.hasNext()) + filterArray[idx++] = (ISystemFilter) (i.next()); + } + return filterArray; + //return null; + } - /** - * Removes a given filter from the list. - * Does NOT follow references to remove them. - * @param filters MOF list to remove from - * @param filter SystemFilter object to remove - */ - public void deleteSystemFilter(java.util.List filters, ISystemFilter filter) - { - filters.remove(filter); - invalidateCache(); - } - /** - * Renames a given filter from the list. - * @param filters java.util.List list - * @param filter SystemFilter object to rename - * @param newName new name to give filter - */ - public void renameSystemFilter(java.util.List filters, ISystemFilter filter, String newName) - { - filter.setName(newName); - invalidateCache(); - } + /** + * Return the filters as an array + */ + public ISystemFilter[] getSystemFilters(Vector filters) { + if (filters == null) return null; + if ((filterArray == null) || (filterArray.length != filters.size())) { + filterArray = new ISystemFilter[filters.size()]; + for (int idx = 0; idx < filters.size(); idx++) + filterArray[idx] = (ISystemFilter) (filters.elementAt(idx)); + } + return filterArray; + } - /** - * Removes a given filter from the list. - * Does NOT follow references to remove them. - * @param filters Vector list to remove from - * @param filter SystemFilter object to remove - */ - public void deleteSystemFilter(Vector filters, ISystemFilter filter) - { - filters.remove(filter); - invalidateCache(); - } - /** - * Renames a given filter from the list. - * @param filters Vector list - * @param filter SystemFilter object to rename - * @param newName new name to give filter - */ - public void renameSystemFilter(Vector filters, ISystemFilter filter, String newName) - { - filter.setName(newName); - invalidateCache(); - } - /** - * Updates a given filter in the list. - * @param filters Vector list - * @param filter SystemFilter object to update - * @param newName new name to give filter - * @param newStrings new strings to give filter - */ - public void updateSystemFilter(Vector filters, ISystemFilter filter, String newName, String[] newStrings) - { - filter.setName(newName); - filter.setFilterStrings(newStrings); - invalidateCache(); - } - /** - * Updates a given filter in the list. - * @param filters java.util.List list - * @param filter SystemFilter object to update - * @param newName new name to give filter - * @param newStrings new strings to give filter - */ - public void updateSystemFilter(java.util.List filters, ISystemFilter filter, String newName, String[] newStrings) - { - filter.setName(newName); - filter.setFilterStrings(newStrings); - invalidateCache(); - } - /** - * Duplicates a given filter in the list. - * @param filters MOF list of filters into which to place the clone - * @param filter SystemFilter object to clone - * @param aliasName New, unique, alias name to give this filter. Clone will fail if this is not unique. - */ - public ISystemFilter cloneSystemFilter(java.util.List filters, ISystemFilter filter, String aliasName) - { + /** + * Return how many filters are defined in this filter container + */ + public int getSystemFilterCount(java.util.List filters) { + int nbrChildren = (filters == null) ? 0 : filters.size(); + return nbrChildren; + } - ISystemFilter copy = - createSystemFilter(filters, filter.getParentFilterPool(), - aliasName, filter.getFilterStringsVector()); - internalAfterCloneSystemFilter(filter, copy); - // now clone nested filters... - ISystemFilter[] nested = filter.getSystemFilters(); - if ((nested!=null) && (nested.length>0)) - for (int idx=0; idx0)) - for (int idx=0; idx 0); + } - /** - * Does core effort to populate a filter clone with non-core attributes - * @param oldFilter SystemFilter original filter - * @param newFilter SystemFilter that is new - */ - public void internalAfterCloneSystemFilter(ISystemFilter oldFilter, ISystemFilter newFilter) - { - newFilter.setParentFilterPool(oldFilter.getParentFilterPool()); - newFilter.setSupportsNestedFilters(oldFilter.isSupportsNestedFilters()); - newFilter.setType(oldFilter.getType()); - newFilter.setDefault(oldFilter.isDefault()); - newFilter.setRelativeOrder(oldFilter.getRelativeOrder()); - } + /** + * Return true if there are system filters + */ + public boolean hasSystemFilters(Vector filters) { + return (filters != null) && (filters.size() > 0); + } - /** - * Return a given filter's zero-based location - */ - public int getSystemFilterPosition(java.util.List filters, ISystemFilter filter) - { - int position = -1; - Iterator i = filters.iterator(); - for (int idx=0; (position<0) && (idx < filters.size()); idx++) - { - ISystemFilter currFilter = (ISystemFilter)i.next(); - if (currFilter.getName().equals(filter.getName())) - position = idx; - } - return position; - } - /** - * Return a given filter's zero-based location - */ - public int getSystemFilterPosition(Vector filters, ISystemFilter filter) - { - int position = -1; - for (int idx=0; (position<0) && (idx < filters.size()); idx++) - { - ISystemFilter currFilter = (ISystemFilter)filters.elementAt(idx); - if (currFilter.getName().equals(filter.getName())) - position = idx; - } - return position; - } + /** + * Return a filter object, given its aliasname. + * Can be used to test if an aliasname is already used (non-null return). + * @param aliasName unique aliasName (case insensitive) to search on. + * @return SystemFilter object with unique aliasName, or null if + * no filter object with this name exists. + */ + public ISystemFilter getSystemFilter(java.util.List filters, String aliasName) { + ISystemFilter filter = null; + ISystemFilter currFilter = null; + Iterator i = filters.iterator(); + while (i.hasNext() && (filter == null)) { + currFilter = (ISystemFilter) i.next(); + if (currFilter.getName().equalsIgnoreCase(aliasName)) filter = currFilter; + } + return filter; + } - - /** - * Move a given filter to a given zero-based location - */ - public void moveSystemFilter(java.util.List filters, int pos, ISystemFilter filter) - { - filters.remove(filter); - filters.add(pos, filter); - invalidateCache(); - } - /** - * Move a given filter to a given zero-based location - */ - public void moveSystemFilter(Vector filters, int pos, ISystemFilter filter) - { - filters.remove(filter); - filters.insertElementAt(filter, pos); - invalidateCache(); - } - + /** + * Return a filter object, given its aliasname. + * Can be used to test if an aliasname is already used (non-null return). + * @param aliasName unique aliasName (case insensitive) to search on. + * @return SystemFilter object with unique aliasName, or null if + * no filter object with this name exists. + */ + public ISystemFilter getSystemFilter(Vector filters, String aliasName) { + if ((filters == null) || (filters.size() == 0)) return null; + ISystemFilter filter = null; + ISystemFilter currFilter = null; + for (int idx = 0; (idx < filters.size()) && (filter == null); idx++) { + currFilter = (ISystemFilter) filters.elementAt(idx); + if (currFilter.getName().equalsIgnoreCase(aliasName)) filter = currFilter; + } + return filter; + } -} \ No newline at end of file + /** + * Adds given filter to the list. + *

PLEASE NOTE: + *

    + *
  • createSystemFilter calls this method for you! + *
  • this is a no-op if a filter with the same aliasname already exists + *
+ * @param filter SystemFilter object to add + * @return true if added, false if filter with this aliasname already existed. + */ + public boolean addSystemFilter(java.util.List filters, ISystemFilter filter) { + boolean exists = getSystemFilter(filters, filter.getName()) != null; + if (!exists) + return internalAddSystemFilter(filters, filter); + else + return false; + } + + /** + * Internally, we can skip the uniqueness checking. + */ + protected boolean internalAddSystemFilter(java.util.List filters, ISystemFilter filter) { + filters.add(filter); + invalidateCache(); + return true; + } + + /** + * Adds given filter to the list. + *

PLEASE NOTE: + *

    + *
  • createSystemFilter calls this method for you! + *
  • this is a no-op if a filter with the same aliasname already exists + *
+ * @param filter SystemFilter object to add + * @return true if added, false if filter with this aliasname already existed. + */ + public boolean addSystemFilter(Vector filters, ISystemFilter filter) { + boolean exists = getSystemFilter(filters, filter.getName()) != null; + if (!exists) + return internalAddSystemFilter(filters, filter); + else + return false; + } + + /** + * Internally, we can skip the uniqueness checking. + */ + private boolean internalAddSystemFilter(Vector filters, ISystemFilter filter) { + filters.add(filter); + invalidateCache(); + return true; + } + + /** + * Removes a given filter from the list. + * Does NOT follow references to remove them. + * @param filters MOF list to remove from + * @param filter SystemFilter object to remove + */ + public void deleteSystemFilter(java.util.List filters, ISystemFilter filter) { + filters.remove(filter); + invalidateCache(); + } + + /** + * Renames a given filter from the list. + * @param filters java.util.List list + * @param filter SystemFilter object to rename + * @param newName new name to give filter + */ + public void renameSystemFilter(java.util.List filters, ISystemFilter filter, String newName) { + filter.setName(newName); + invalidateCache(); + } + + /** + * Removes a given filter from the list. + * Does NOT follow references to remove them. + * @param filters Vector list to remove from + * @param filter SystemFilter object to remove + */ + public void deleteSystemFilter(Vector filters, ISystemFilter filter) { + filters.remove(filter); + invalidateCache(); + } + + /** + * Renames a given filter from the list. + * @param filters Vector list + * @param filter SystemFilter object to rename + * @param newName new name to give filter + */ + public void renameSystemFilter(Vector filters, ISystemFilter filter, String newName) { + filter.setName(newName); + invalidateCache(); + } + + /** + * Updates a given filter in the list. + * @param filters Vector list + * @param filter SystemFilter object to update + * @param newName new name to give filter + * @param newStrings new strings to give filter + */ + public void updateSystemFilter(Vector filters, ISystemFilter filter, String newName, String[] newStrings) { + filter.setName(newName); + filter.setFilterStrings(newStrings); + invalidateCache(); + } + + /** + * Updates a given filter in the list. + * @param filters java.util.List list + * @param filter SystemFilter object to update + * @param newName new name to give filter + * @param newStrings new strings to give filter + */ + public void updateSystemFilter(java.util.List filters, ISystemFilter filter, String newName, String[] newStrings) { + filter.setName(newName); + filter.setFilterStrings(newStrings); + invalidateCache(); + } + + /** + * Duplicates a given filter in the list. + * @param filters MOF list of filters into which to place the clone + * @param filter SystemFilter object to clone + * @param aliasName New, unique, alias name to give this filter. Clone will fail if this is not unique. + */ + public ISystemFilter cloneSystemFilter(java.util.List filters, ISystemFilter filter, String aliasName) { + + ISystemFilter copy = createSystemFilter(filters, filter.getParentFilterPool(), aliasName, filter.getFilterStringsVector()); + internalAfterCloneSystemFilter(filter, copy); + // now clone nested filters... + ISystemFilter[] nested = filter.getSystemFilters(); + if ((nested != null) && (nested.length > 0)) for (int idx = 0; idx < nested.length; idx++) { + + } + return copy; + } + + /** + * Duplicates a given filter in the list. + * @param filters Vector of filters into which to place the clone + * @param filter SystemFilter object to clone + * @param aliasName New, unique, alias name to give this filter. Clone will fail if this is not unique. + */ + public ISystemFilter cloneSystemFilter(Vector filters, ISystemFilter filter, String aliasName) { + + ISystemFilter copy = createSystemFilter(filters, filter.getParentFilterPool(), aliasName, filter.getFilterStringsVector()); + internalAfterCloneSystemFilter(filter, copy); + // now clone nested filters... + ISystemFilter[] nested = filter.getSystemFilters(); + if ((nested != null) && (nested.length > 0)) for (int idx = 0; idx < nested.length; idx++) { + + } + return copy; + } + + /** + * Does core effort to populate a filter clone with non-core attributes + * @param oldFilter SystemFilter original filter + * @param newFilter SystemFilter that is new + */ + public void internalAfterCloneSystemFilter(ISystemFilter oldFilter, ISystemFilter newFilter) { + newFilter.setParentFilterPool(oldFilter.getParentFilterPool()); + newFilter.setSupportsNestedFilters(oldFilter.isSupportsNestedFilters()); + newFilter.setType(oldFilter.getType()); + newFilter.setDefault(oldFilter.isDefault()); + newFilter.setRelativeOrder(oldFilter.getRelativeOrder()); + } + + /** + * Return a given filter's zero-based location + */ + public int getSystemFilterPosition(java.util.List filters, ISystemFilter filter) { + int position = -1; + Iterator i = filters.iterator(); + for (int idx = 0; (position < 0) && (idx < filters.size()); idx++) { + ISystemFilter currFilter = (ISystemFilter) i.next(); + if (currFilter.getName().equals(filter.getName())) position = idx; + } + return position; + } + + /** + * Return a given filter's zero-based location + */ + public int getSystemFilterPosition(Vector filters, ISystemFilter filter) { + int position = -1; + for (int idx = 0; (position < 0) && (idx < filters.size()); idx++) { + ISystemFilter currFilter = (ISystemFilter) filters.elementAt(idx); + if (currFilter.getName().equals(filter.getName())) position = idx; + } + return position; + } + + /** + * Move a given filter to a given zero-based location + */ + public void moveSystemFilter(java.util.List filters, int pos, ISystemFilter filter) { + filters.remove(filter); + filters.add(pos, filter); + invalidateCache(); + } + + /** + * Move a given filter to a given zero-based location + */ + public void moveSystemFilter(Vector filters, int pos, ISystemFilter filter) { + filters.remove(filter); + filters.insertElementAt(filter, pos); + invalidateCache(); + } + +} \ No newline at end of file