org.eclipse.rse.core.references
Interface IRSEBaseReferencedObject

All Known Subinterfaces:

IRSEBasePersistableReferencedObject, IRSEPersistableReferencedObject, IRSEReferencedObject, ISystemFilter, ISystemFilterPool, ISystemFilterString

All Known Implementing Classes:

org.eclipse.rse.internal.filters.SystemFilter, SystemFilterPool, org.eclipse.rse.internal.references.SystemPersistableReferencedObject, org.eclipse.rse.internal.references.SystemReferencedObject

public interface IRSEBaseReferencedObject

Interface that any master object that is referenced must implement.

Method Summary

int	addReference(IRSEBaseReferencingObject ref) Add a reference, increment reference count, return new count
int	getReferenceCount()
IRSEBaseReferencingObject[]	getReferencingObjects()
void	removeAllReferences() Clear the list of referenced objects.
int	removeReference(IRSEBaseReferencingObject ref) Remove a reference, decrement reference count, return new count

Method Detail

addReference

public int addReference(IRSEBaseReferencingObject ref)

Add a reference, increment reference count, return new count

Parameters:

ref - the referencing object from which this object will now be referenced.

Returns:

new count of how many referencing objects reference this object.

removeReference

public int removeReference(IRSEBaseReferencingObject ref)

Remove a reference, decrement reference count, return new count

Parameters:

ref - the referencing object from which this object is no longer referenced.

Returns:

new count of how many referencing objects reference this object.

getReferenceCount

public int getReferenceCount()

Returns:

a count of how many referencing objects reference this object.

removeAllReferences

public void removeAllReferences()

Clear the list of referenced objects.

getReferencingObjects

public IRSEBaseReferencingObject[] getReferencingObjects()

Returns:

a list of all referencing objects of this object