mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-29 11:55:40 +02:00
Code Issues Wiki Activity

[cleanup] format and javadoc

Browse source
This commit is contained in:
David Dykstal 2006-09-20 00:32:43 +00:00
parent e2129044ea
commit e97fb98f5f
1 changed files with 15 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferencedObject.java
View file

@ -17,33 +17,31 @@
package org.eclipse.rse.core.references; package org.eclipse.rse.core.references;
/** /**
* Referenced objects are objects that have shadow objects of them. * Referenced objects are objects that have shadow objects (referencing objects) of them.
* Typically, shadows are created to enable a GUI which does not allow the same * Typically, references are created to enable a UI which does not allow the same
* real object to appear multiple times. In these cases, a unique shadow object * real object to appear multiple times. In these cases, a unique reference object
* is created for each unique instance of the real object. * is created for each unique instance of the real object.
* <p> * <p>
* The parent interface IRSEReferencedObject captures the simple set of methods * The parent interface IRSEReferencedObject captures the simple set of methods
* an object that supports such a shadow must implement. * an object that supports such a real object implement.
* <p> * <p>
* This interface specializes that for the case of objects which support references * This interface specializes that for the case of real objects that support references
* that must be persisted. * that must be persisted.
* Typically, we build the references in memory at runtime just to satisfy the GUI. * Typically, we build the references in memory at runtime to satisfy the UI.
* However, occassionally we build the list of references for a more permanent reason, * However, occassionally we build the list of references for a more permanent reason,
* such as when we let a user choose a subset from a master list. * such as when we let a user choose a subset from a master list.
* <p> * <p>
* When we persist such a reference, we can't persist the memory reference to the master * When we persist such a reference, we can't persist the memory reference to the master
* object. Instead, we persist the unique name or key of that object, and upon restoring * object. Instead, we persist the unique name of that object, and upon restoring
* from disk we then resolve that into a runtime reference to a real memory object. * from disk we then resolve that into a runtime reference to a real memory object.
* <p> * <p>
* This interface captures the method to allow a shadow or referencing object to * This interface supplies the method to allow a referencing object to
* query that unique name or key from this referencable master object. * query that unique name or key from this real object.
*/ */
public interface IRSEBasePersistableReferencedObject public interface IRSEBasePersistableReferencedObject extends IRSEBaseReferencedObject {
extends IRSEBaseReferencedObject
{
/** /**
* Query the unique name or key of this master object to record in the referencing object. * @return the unique name or key of this master object to record in the referencing object.
*/ */
public String getReferenceName(); public String getReferenceName();
} }