From f441ef083bd84eef91869e8de7d2edf6519b7761 Mon Sep 17 00:00:00 2001 From: David Dykstal Date: Wed, 20 Sep 2006 20:38:29 +0000 Subject: [PATCH] [cleanup] format and javadoc --- .../references/IRSEBaseReferencingObject.java | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencingObject.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencingObject.java index 4414d085d5c..563b08fe065 100644 --- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencingObject.java +++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencingObject.java @@ -15,6 +15,7 @@ ********************************************************************************/ package org.eclipse.rse.core.references; + /** * 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. @@ -23,16 +24,18 @@ package org.eclipse.rse.core.references; *

* 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 + * @param obj the object to reference */ public void setReferencedObject(IRSEBaseReferencedObject obj); + /** - * Get the object which we reference + * @return the object which we reference */ public IRSEBaseReferencedObject getReferencedObject(); + /** * Fastpath to getReferencedObject().removeReference(this). * @return new reference count of master object @@ -40,12 +43,13 @@ public interface IRSEBaseReferencingObject 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); - + /** - * Return true if this reference is currently broken/unresolved + * @return true if this reference is currently broken/unresolved */ - public boolean isReferenceBroken(); + public boolean isReferenceBroken(); + } \ No newline at end of file