Eclipse RSE Development Guide (Galileo) - SystemReferencingObject (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.references
Class SystemReferencingObject


java.lang.Object
  

org.eclipse.rse.core.model.RSEPersistableObject
      

org.eclipse.rse.core.model.PropertySetContainer
          

org.eclipse.rse.core.model.RSEModelObject
              
org.eclipse.rse.core.references.SystemReferencingObject

All Implemented Interfaces:: IPropertySetContainer, IRSEModelObject, IRSEPersistableContainer, IRSEBaseReferencingObject, IRSEReferencingObject

Direct Known Subclasses:: SystemFilterReference

public abstract class SystemReferencingObject
extends RSEModelObject
implements IRSEReferencingObject
extends RSEModelObject
implements IRSEReferencingObject

A class to encapsulate the operations required of an object which is merely a reference to another object, something we call a shadow. Such shadows are needed to support a UI which displays the same object in multiple places. To enable that, it is necessary not to use the same physical object in each UI representation as the UI will only know how to update/refresh the first one it finds.

Since:: org.eclipse.rse.core 3.0

Field Summary

protected boolean referenceBroken


Fields inherited from interface org.eclipse.rse.core.model. IRSEPersistableContainer

NO_CHILDREN

Constructor Summary

protected SystemReferencingObject ()
          Default constructor.

Method Summary

String getDescription ()


protected SystemReferencingObjectHelper getHelper ()


IRSEBaseReferencedObject getReferencedObject ()


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

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

void setReferenceBroken (boolean broken)
          Set to true if this reference is currently broken/unresolved

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

Methods inherited from class org.eclipse.rse.core.model. PropertySetContainer

addPropertySet, addPropertySets, createPropertySet, createPropertySet, getPropertySet, getPropertySets, removePropertySet

Methods inherited from class org.eclipse.rse.core.model. RSEPersistableObject

compareStrings, isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.rse.core.model. IRSEModelObject

getName

Methods inherited from interface org.eclipse.rse.core.model. IPropertySetContainer

addPropertySet, addPropertySets, createPropertySet, createPropertySet, getPropertySet, getPropertySets, removePropertySet

Methods inherited from interface org.eclipse.rse.core.model. IRSEPersistableContainer

commit, getPersistableChildren, getPersistableParent, isDirty, isTainted, setDirty, setTainted, setWasRestored, wasRestored

Field Detail

referenceBroken

protected boolean referenceBroken

Constructor Detail

SystemReferencingObject

protected SystemReferencingObject()

Default constructor.

Method Detail

setReferencedObject

public void setReferencedObject(
IRSEBaseReferencedObject obj)

Description copied from interface: IRSEBaseReferencingObject

Set the object to which we reference

Specified by:: setReferencedObject in interface IRSEBaseReferencingObject

Parameters:: obj - the object to reference

getReferencedObject

public 
IRSEBaseReferencedObject getReferencedObject()

Specified by:: getReferencedObject in interface IRSEBaseReferencingObject

Returns:: the object which we reference

removeReference

public int removeReference()