com4j.util

Class ComObjectCollector

java.lang.Object

com4j.util.ComObjectCollector

All Implemented Interfaces:

ComObjectListener

public class ComObjectCollector
extends Object
implements ComObjectListener

ComObjectListener implementation that collects all newly created Com4jObjects

The intended use of this class is to record objects created in a certain block and then dispose them all (except a few marked explicitly) at once at some later point.

See the following code example for a typical usage:

 
    void foo() {
        // we will start using COM objects.
        // so we'll register the listener and start keeping
        // track of COM objects we create.
        ComObjectCollector col = new ComObjectCollector();
        COM4J.addListener(col);

        try {
            // use COM objects as much as you want
            IFoo foo = doALotOfComStuff();

            // do this to avoid COM objects from disposed by the disposeAll method.
            col.remove(foo);
        } finally {
            // dispose all the COM objects created in this thread
            // since the listener is registered.
            // But "foo" won't be disposed because of the remove method.
            col.disposeAll();

            // make sure to remove the listener
            COM4J.removeListener(col);
        }
    }

Author:

Kohsuke Kawaguchi (kk@kohsuke.org), Michael Poindexter (staticsnow@gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected List<WeakReference<Com4jObject>>	objects The collected Com4jObjects

Constructor Summary

Constructors

Constructor and Description
ComObjectCollector()

Method Summary

Methods

Modifier and Type	Method and Description
void	disposeAll() Calls the Com4jObject.dispose() method for all the Com4jObjects known to this ComObjectCollector.
void	onNewObject(Com4jObject obj) Called when a new COM object is created.
void	remove(Com4jObject obj) Removes the given object from the list of Com4jObjects that this class keeps.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

objects

protected final List<WeakReference<Com4jObject>> objects

The collected Com4jObjects

Constructor Detail

ComObjectCollector

public ComObjectCollector()

Method Detail

onNewObject

public void onNewObject(Com4jObject obj)

Description copied from interface: ComObjectListener

Called when a new COM object is created.

Specified by:

onNewObject in interface ComObjectListener

Parameters:

obj - the newly created Com4jObject

remove

public void remove(Com4jObject obj)

Removes the given object from the list of Com4jObjects that this class keeps.

If the application knows certain Com4jObject needs to live after the disposeAll() method, this method can be called to avoid the object from being disposed.

If the object passed in is not known to this ComObjectCollector, it is a no-op.

Parameters:

obj - The object to remove

disposeAll

public void disposeAll()

Calls the Com4jObject.dispose() method for all the Com4jObjects known to this ComObjectCollector.

Each time this method is called, it forgets all the disposed objects.