mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-30 12:25:35 +02:00
Code Issues Wiki Activity

[cleanup] javadoc and formatting

Browse source
This commit is contained in:
David Dykstal 2007-01-02 14:49:27 +00:00
parent 74a30761e1
commit 940d4cfa5a
1 changed files with 47 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

87
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainerReference.java
View file

@ -18,29 +18,25 @@ package org.eclipse.rse.core.filters;
import org.eclipse.rse.core.subsystems.ISubSystem; import org.eclipse.rse.core.subsystems.ISubSystem;
/** /**
* Both SystemFilter and SystemFilterPool contain filters, so the * Both ISystemFilter and ISystemFilterPool may contain filters, so the
* common methods for filters are abstracted out in SystemFilterContainer, * common methods for filters are abstracted out in SystemFilterContainer,
* which both classes implement. * which both classes implement.
* Both SystemFilterReference and SystemFilterPoolReference hold references * Both ISystemFilterReference and ISystemFilterPoolReference hold references
* to SystemFilterContainer objects (either SystemFilter or SystemFilterPool). * to ISystemFilterContainer objects.
* There are a couple of methods that are common to both classes, related to * There are methods common to both classes, related to
* getting an array of references to the filters that are held by the referenced * getting an array of references to the filters that are held by the referenced
* object. * object.
* This interface captures those common methods, and both * This interface captures those common methods, and both
* SystemFilterReferenceImpl and SystemFilterPoolReferenceImpl * SystemFilterReference and SystemFilterPoolReference
* implement this interface and hence these methods. * implement this interface and hence these methods.
* @see org.eclipse.rse.internal.filters.SystemFilterContainerReferenceCommonMethods
*/ */
public interface ISystemFilterContainerReference public interface ISystemFilterContainerReference {
{
/** /**
* Return the object to which we hold a reference. This is either * @return the filter container object which is referenced.
* SystemFilter or SystemFilterPool. Since both implement
* SystemFilterContainer, that is what we return.
*/ */
public ISystemFilterContainer getReferencedSystemFilterContainer(); public ISystemFilterContainer getReferencedSystemFilterContainer();
/** /**
* Build and return an array of SystemFilterReference objects. * Build and return an array of SystemFilterReference objects.
* Each object is created new. There is one for each of the filters * 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 * For performance reasons, we will cache this array and only
* return a fresh one if something changes in the underlying * return a fresh one if something changes in the underlying
* filter list. * filter list.
* @param subSystem the subsystem from which to get the filter references.
*/ */
public ISystemFilterReference[] getSystemFilterReferences(ISubSystem subSystem); 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. * Finds an existing filter in a particular subsystem.
* For such objects this is what we show in the GUI. * @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(); public String getName();
/** /**
* Return true if the referenced pool or filter has filters. * @return true if this container has filters.
*/ */
public boolean hasFilters(); public boolean hasFilters();
/** /**
* Return count of the number of filters in the referenced pool or filter * @return the number of filters in the referenced container
*/ */
public int getFilterCount(); public int getFilterCount();
} }