Eclipse RSE Development Guide (Galileo) - ISystemFilterContainerReference (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.core.filters
Interface ISystemFilterContainerReference

All Known Subinterfaces:: ISystemFilterPoolReference, ISystemFilterReference

All Known Implementing Classes:: SystemFilterReference

public interface ISystemFilterContainerReference

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 SystemFilterReference and SystemFilterPoolReference implement this interface and hence these methods.

Method Summary

ISystemFilterReference getExistingSystemFilterReference ( ISubSystem subSystem, ISystemFilter filter)
          Finds an existing filter in a particular subsystem.

int getFilterCount ()


String getName ()


ISystemFilterContainer getReferencedSystemFilterContainer ()


ISystemFilterReference getSystemFilterReference ( ISubSystem subSystem, ISystemFilter filter)
          Find or create a single filter refererence to a given filter.

ISystemFilterReference[] getSystemFilterReferences ( ISubSystem subSystem)
          Build and return an array of SystemFilterReference objects.

boolean hasFilters ()

Method Detail

getReferencedSystemFilterContainer


ISystemFilterContainer getReferencedSystemFilterContainer()

Returns:: the filter container object which is referenced.

getSystemFilterReferences


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.

Parameters:: subSystem - the subsystem from which to get the filter references.

getExistingSystemFilterReference


ISystemFilterReference getExistingSystemFilterReference(
ISubSystem subSystem,
                                                        
ISystemFilter filter)

Finds an existing filter in a particular subsystem.

Parameters:: subSystem - the subsystem in which to look for the filter reference.; filter - the filter for which to look.
Returns:: an existing reference to a given system filter. If no reference currently exists to this filter, returns null.
See Also:: getSystemFilterReference(ISubSystem, ISystemFilter)

getSystemFilterReference


ISystemFilterReference getSystemFilterReference(
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.

Parameters:: subSystem - the subsystem in which to find or create the filter.; filter - the filter to for which to create a reference.
See Also:: getExistingSystemFilterReference(ISubSystem, ISystemFilter)

getName


String getName()

Returns:: the name of the SystemFilter or SystemFilterPool that we reference.

hasFilters

boolean hasFilters()

Returns:: true if this container has filters.

getFilterCount

int getFilterCount()

Returns:: the number of filters in the referenced container