org.eclipse.rse.core.filters
Interface ISystemFilterContainerReference

All Known Subinterfaces:

ISystemFilterPoolReference, ISystemFilterReference

All Known Implementing Classes:

SystemFilterReference

public interface ISystemFilterContainerReference

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. This interface captures those common methods, and both SystemFilterReferenceImpl and SystemFilterPoolReferenceImpl implement this interface and hence these methods.

See Also:

SystemFilterContainerReferenceCommonMethods

Method Summary

ISystemFilterReference	getExistingSystemFilterReference(ISubSystem subSystem, ISystemFilter filter) Return an existing reference to a given system filter.
int	getFilterCount() Return count of the number of filters in the referenced pool or filter
String	getName() Return the name of the SystemFilter or SystemFilterPool that we reference.
ISystemFilterContainer	getReferencedSystemFilterContainer() Return the object to which we hold a reference.
ISystemFilterReference	getSystemFilterReference(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.
ISystemFilterReference[]	getSystemFilterReferences(ISubSystem subSystem) Build and return an array of SystemFilterReference objects.
boolean	hasFilters() Return true if the referenced pool or filter has filters.

Method Detail

getReferencedSystemFilterContainer

public ISystemFilterContainer getReferencedSystemFilterContainer()

Return the object to which we hold a reference. This is either SystemFilter or SystemFilterPool. Since both implement SystemFilterContainer, that is what we return.

getSystemFilterReferences

public ISystemFilterReference[] getSystemFilterReferences(ISubSystem subSystem)

Build and return an array of SystemFilterReference objects. Each object is created new. There is one for each of the filters in the reference SystemFilter or SystemFilterPool. For performance reasons, we will cache this array and only return a fresh one if something changes in the underlying filter list.

getExistingSystemFilterReference

public ISystemFilterReference getExistingSystemFilterReference(ISubSystem subSystem,
                                                               ISystemFilter filter)

Return an existing reference to a given system filter. If no reference currently exists to this filter, returns null.

See Also:

#getSystemFilterReference(ISystemFilter)

getSystemFilterReference

public ISystemFilterReference getSystemFilterReference(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 Also:

#getExistingSystemFilterReference(ISystemFilter)

getName

public String getName()

Return the name of the SystemFilter or SystemFilterPool that we reference. For such objects this is what we show in the GUI.

hasFilters

public boolean hasFilters()

Return true if the referenced pool or filter has filters.

getFilterCount

public int getFilterCount()

Return count of the number of filters in the referenced pool or filter