mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-23 16:23:52 +02:00
Code Issues Wiki Activity

[cleanup] format and javadoc

Browse source
This commit is contained in:
David Dykstal 2006-09-20 20:38:29 +00:00
parent 17ca25453c
commit f441ef083b
1 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencingObject.java
View file

@ -15,6 +15,7 @@
********************************************************************************/ ********************************************************************************/
package org.eclipse.rse.core.references; package org.eclipse.rse.core.references;
/** /**
* Referencing objects are shadows of real objects. Typically, shadows are created * 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. * to enable a GUI which does not allow the same real object to appear multiple times.
@ -23,16 +24,18 @@ package org.eclipse.rse.core.references;
* <p> * <p>
* This interface captures the simple set of methods such a shadow must implement. * This interface captures the simple set of methods such a shadow must implement.
*/ */
public interface IRSEBaseReferencingObject public interface IRSEBaseReferencingObject {
{
/** /**
* Set the object to which we reference * Set the object to which we reference
* @param obj the object to reference
*/ */
public void setReferencedObject(IRSEBaseReferencedObject obj); public void setReferencedObject(IRSEBaseReferencedObject obj);
/** /**
* Get the object which we reference * @return the object which we reference
*/ */
public IRSEBaseReferencedObject getReferencedObject(); public IRSEBaseReferencedObject getReferencedObject();
/** /**
* Fastpath to getReferencedObject().removeReference(this). * Fastpath to getReferencedObject().removeReference(this).
* @return new reference count of master object * @return new reference count of master object
@ -40,12 +43,13 @@ public interface IRSEBaseReferencingObject
public int removeReference(); public int removeReference();
/** /**
* Set to true if this reference is currently broken/unresolved * @param broken true if this reference is currently broken/unresolved
*/ */
public void setReferenceBroken(boolean broken); public void setReferenceBroken(boolean broken);
/** /**
* Return true if this reference is currently broken/unresolved * @return true if this reference is currently broken/unresolved
*/ */
public boolean isReferenceBroken(); public boolean isReferenceBroken();
} }