1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-06-09 18:56:02 +02:00

[cleanup] format and javadoc

This commit is contained in:
David Dykstal 2006-09-20 00:14:35 +00:00
parent 068d19c73a
commit 2ffdfb8aff

View file

@ -15,31 +15,37 @@
********************************************************************************/ ********************************************************************************/
package org.eclipse.rse.core.references; package org.eclipse.rse.core.references;
/** /**
* Interface that any master object that is referenced must implement. * Interface that any master object that is referenced must implement.
*/ */
public interface IRSEBaseReferencedObject public interface IRSEBaseReferencedObject {
{
/** /**
* Add a reference, increment reference count, return new count * Add a reference, increment reference count, return new count
* @param ref the referencing object from which this object will now be referenced.
* @return new count of how many referencing objects reference this object. * @return new count of how many referencing objects reference this object.
*/ */
public int addReference(IRSEBaseReferencingObject ref); public int addReference(IRSEBaseReferencingObject ref);
/** /**
* Remove a reference, decrement reference count, return new count * Remove a reference, decrement reference count, return new count
* @param ref the referencing object from which this object is no longer referenced.
* @return new count of how many referencing objects reference this object. * @return new count of how many referencing objects reference this object.
*/ */
public int removeReference(IRSEBaseReferencingObject ref); public int removeReference(IRSEBaseReferencingObject ref);
/** /**
* Return a count of how many referencing objects reference this object. * @return a count of how many referencing objects reference this object.
*/ */
public int getReferenceCount(); public int getReferenceCount();
/** /**
* Clear the list of referenced objects. * Clear the list of referenced objects.
*/ */
public void removeAllReferences(); public void removeAllReferences();
/** /**
* Return a list of all referencing objects of this object * @return a list of all referencing objects of this object
*/ */
public IRSEBaseReferencingObject[] getReferencingObjects(); public IRSEBaseReferencingObject[] getReferencingObjects();
} }