com4j.EventCookie Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of com4j

There is a newer version: 20110320

package com4j;

/**
 * Represents a subscription to COM events.
 *
 * 
 * When you are subscribing to COM events, com4j
 * makes sure that your object will not be garbage collected.
 * (Even if you release all the references to the event source
 * COM object, {@link EventCookie} still retains an interface pointer.)
 *
 * 

 * Therefore, you must call {@link #close()} to terminate
 * the subscription, or memory will leak.
 *
 * @author Kohsuke Kawaguchi
 */
public interface EventCookie {
    /**
     * Terminates the event subscription.
     *
     * 
     * This method can be safely invoked multiple times.
     */
    void close();
}