Remote Systems
v6.4.1

com.ibm.etools.systems.references.impl
Class SystemReferencingObjectHelper

java.lang.Object
  extended bycom.ibm.etools.systems.references.impl.SystemReferencingObjectHelper
Direct Known Subclasses:
SystemPersistableReferencingObjectHelper

public class SystemReferencingObjectHelper
extends Object

This is a class that implements all the methods in the ISystemReferencingObject. It makes implementing this interface trivial. The easiest use of this class is to subclass it, but since that is not always possible, it is not abstract and hence can be leveraged via containment.


Field Summary
static String copyright
           
 
Constructor Summary
SystemReferencingObjectHelper(ISystemReferencingObject caller)
          Default constructor.
SystemReferencingObjectHelper(ISystemReferencingObject caller, ISystemReferencedObject obj)
          Constructor that saves effort of calling setReferencedObject.
 
Method Summary
 ISystemReferencedObject getReferencedObject()
          Get the object which we reference
 int removeReference()
          Fastpath to getReferencedObject().removeReference(this).
 void setReferencedObject(ISystemReferencedObject obj)
          Set the object to which we reference.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Constructor Detail

SystemReferencingObjectHelper

public SystemReferencingObjectHelper(ISystemReferencingObject caller)
Default constructor.


SystemReferencingObjectHelper

public SystemReferencingObjectHelper(ISystemReferencingObject caller,
                                     ISystemReferencedObject obj)
Constructor that saves effort of calling setReferencedObject.

Method Detail

setReferencedObject

public void setReferencedObject(ISystemReferencedObject obj)
Set the object to which we reference. Stores the reference in memory, replacing whatever was there. Also, calls obj.addReference(caller);


getReferencedObject

public ISystemReferencedObject getReferencedObject()
Get the object which we reference


removeReference

public int removeReference()
Fastpath to getReferencedObject().removeReference(this). Also, nulls out our memory reference.

Returns:
new reference count of master object

Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.