From 940d4cfa5a7ed7c67cfe998b4a7781f4f5ff7ba7 Mon Sep 17 00:00:00 2001 From: David Dykstal Date: Tue, 2 Jan 2007 14:49:27 +0000 Subject: [PATCH] [cleanup] javadoc and formatting --- .../ISystemFilterContainerReference.java | 91 ++++++++++--------- 1 file changed, 47 insertions(+), 44 deletions(-) diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainerReference.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainerReference.java index b35e8fb7e92..f0841f8cd1b 100644 --- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainerReference.java +++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainerReference.java @@ -18,29 +18,25 @@ package org.eclipse.rse.core.filters; import org.eclipse.rse.core.subsystems.ISubSystem; - /** - * Both SystemFilter and SystemFilterPool contain filters, so the - * common methods for filters are abstracted out in SystemFilterContainer, - * which both classes implement. - * Both SystemFilterReference and SystemFilterPoolReference hold references - * to SystemFilterContainer objects (either SystemFilter or SystemFilterPool). - * There are a couple of methods that are common to both classes, related to - * getting an array of references to the filters that are held by the referenced - * object. + * Both ISystemFilter and ISystemFilterPool may contain filters, so the + * common methods for filters are abstracted out in SystemFilterContainer, + * which both classes implement. + * Both ISystemFilterReference and ISystemFilterPoolReference hold references + * to ISystemFilterContainer objects. + * There are methods common to both classes, related to + * getting an array of references to the filters that are held by the referenced + * object. * This interface captures those common methods, and both - * SystemFilterReferenceImpl and SystemFilterPoolReferenceImpl - * implement this interface and hence these methods. - * @see org.eclipse.rse.internal.filters.SystemFilterContainerReferenceCommonMethods + * SystemFilterReference and SystemFilterPoolReference + * implement this interface and hence these methods. */ -public interface ISystemFilterContainerReference -{ +public interface ISystemFilterContainerReference { /** - * Return the object to which we hold a reference. This is either - * SystemFilter or SystemFilterPool. Since both implement - * SystemFilterContainer, that is what we return. + * @return the filter container object which is referenced. */ public ISystemFilterContainer getReferencedSystemFilterContainer(); + /** * Build and return an array of SystemFilterReference objects. * Each object is created new. There is one for each of the filters @@ -48,35 +44,42 @@ public interface ISystemFilterContainerReference * For performance reasons, we will cache this array and only * return a fresh one if something changes in the underlying * filter list. + * @param subSystem the subsystem from which to get the filter references. */ public ISystemFilterReference[] getSystemFilterReferences(ISubSystem subSystem); - /** - * Return an existing reference to a given system filter. - * If no reference currently exists to this filter, returns null. - * @see #getSystemFilterReference(ISystemFilter) - */ - public ISystemFilterReference getExistingSystemFilterReference(ISubSystem subSystem, ISystemFilter filter); - /** - * Create a single filter refererence to a given filter - * If there already is a reference to this filter, it is returned. - * If not, a new reference is created and appended to the end of the existing filter reference array. - * @see #getExistingSystemFilterReference(ISystemFilter) - */ - public ISystemFilterReference getSystemFilterReference(ISubSystem subSystem, ISystemFilter filter); - - /** - * Return the name of the SystemFilter or SystemFilterPool that we reference. - * For such objects this is what we show in the GUI. - */ + + /** + * Finds an existing filter in a particular subsystem. + * @param subSystem the subsystem in which to look for the filter reference. + * @param filter the filter for which to look. + * @return an existing reference to a given system filter. + * If no reference currently exists to this filter, returns null. + * @see #getSystemFilterReference(ISubSystem, ISystemFilter) + */ + public ISystemFilterReference getExistingSystemFilterReference(ISubSystem subSystem, ISystemFilter filter); + + /** + * Find or create a single filter refererence to a given filter. + * If there already is a reference to this filter, in this subsystem it will be returned. + * If not, a new reference is created and added at the end of the list of filter references. + * @param subSystem the subsystem in which to find or create the filter. + * @param filter the filter to for which to create a reference. + * @see #getExistingSystemFilterReference(ISubSystem, ISystemFilter) + */ + public ISystemFilterReference getSystemFilterReference(ISubSystem subSystem, ISystemFilter filter); + + /** + * @return the name of the SystemFilter or SystemFilterPool that we reference. + */ public String getName(); - /** - * Return true if the referenced pool or filter has filters. - */ - public boolean hasFilters(); - - /** - * Return count of the number of filters in the referenced pool or filter - */ - public int getFilterCount(); + /** + * @return true if this container has filters. + */ + public boolean hasFilters(); + + /** + * @return the number of filters in the referenced container + */ + public int getFilterCount(); } \ No newline at end of file