io.scif.refs

Interface RefManagerService

All Superinterfaces:

Comparable<org.scijava.Prioritized>, org.scijava.Contextual, org.scijava.Disposable, org.scijava.plugin.HasPluginInfo, org.scijava.Identifiable, org.scijava.Initializable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.Prioritized, org.scijava.plugin.RichPlugin, SCIFIOService, org.scijava.plugin.SciJavaPlugin, org.scijava.service.Service, org.scijava.Versioned

All Known Implementing Classes:

DefaultRefManagerService

public interface RefManagerService
extends SCIFIOService

A Service implementation for helping with Reference management.

The manage(Object, Object...) method creates and registers a CleaningRef instance with this service, using the given object as its referent, which allows the CleaningRef.cleanup() method to be handled on a separate thread.

Author:

Mark Hiner

Method Summary

Modifier and Type	Method and Description
void	manage(Object referent, Object... params) If there is a corresponding CleaningRef for the given object, it will be created using the given object as its referent and attached to a reference queue.

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Versioned

getVersion

Methods inherited from interface org.scijava.Disposable

dispose

Method Detail

manage

void manage(Object referent,
            Object... params)

If there is a corresponding CleaningRef for the given object, it will be created using the given object as its referent and attached to a reference queue. A separate thread will poll the queue, and whenever a reference is dequeued its CleaningRef.cleanup() method will be invoked.

NB: no more than one of a given Reference type will be managed for a given referent. An object shouldn't require more than one cleanup for a given usage.