RSE
Release 3.2

org.eclipse.rse.core.references
Interface IRSEBaseReferencingObject

All Known Subinterfaces:
IRSEBasePersistableReferencingObject, IRSEPersistableReferencingObject, IRSEReferencingObject, ISystemFilterPoolReference, ISystemFilterReference, ISystemFilterStringReference
All Known Implementing Classes:
SystemFilterReference, SystemReferencingObject

public interface IRSEBaseReferencingObject

Referencing objects are shadows of real objects. Typically, shadows are created to enable a GUI which does not allow the same real object to appear multiple times. In these cases, a unique shadow object is created for each unique instance of the real object.

This interface captures the simple set of methods such a shadow must implement.


Method Summary
 IRSEBaseReferencedObject getReferencedObject()
           
 boolean isReferenceBroken()
           
 int removeReference()
          Fastpath to getReferencedObject().removeReference(this).
 void setReferenceBroken(boolean broken)
           
 void setReferencedObject(IRSEBaseReferencedObject obj)
          Set the object to which we reference
 

Method Detail

setReferencedObject

void setReferencedObject(IRSEBaseReferencedObject obj)
Set the object to which we reference

Parameters:
obj - the object to reference

getReferencedObject

IRSEBaseReferencedObject getReferencedObject()
Returns:
the object which we reference

removeReference

int removeReference()
Fastpath to getReferencedObject().removeReference(this).

Returns:
new reference count of master object

setReferenceBroken

void setReferenceBroken(boolean broken)
Parameters:
broken - true if this reference is currently broken/unresolved

isReferenceBroken

boolean isReferenceBroken()
Returns:
true if this reference is currently broken/unresolved

RSE
Release 3.2

Copyright (c) IBM Corporation and others 2000, 2010. All Rights Reserved.