io.scif.refs

Interface RefProvider

All Superinterfaces:

Comparable<org.scijava.Prioritized>, org.scijava.Contextual, org.scijava.plugin.HasPluginInfo, org.scijava.Identifiable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.Prioritized, org.scijava.plugin.RichPlugin, SCIFIOPlugin, org.scijava.plugin.SciJavaPlugin, org.scijava.plugin.SingletonPlugin, org.scijava.Versioned

All Known Implementing Classes:

ImgPlusCtxCleaningProvider

public interface RefProvider
extends SCIFIOPlugin, org.scijava.plugin.SingletonPlugin

Interface for plugins that create references for a given referent. Each RefProvider is uniquely identified by its referent and parameter combination defined by the handles(Object, Object...) method. If this method returns true, it is safe to pass the referent and parameters to this RefProvider, along with the ReferenceQueue the resulting reference should be enqueued in.

Author:

Mark Hiner

Method Summary

Modifier and Type	Method and Description
boolean	handles(Object referent, Object... params)
Reference	makeRef(Object referent, ReferenceQueue queue, Object... params)

Methods inherited from interface io.scif.SCIFIOPlugin

getVersion, log

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier

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

Method Detail

handles

boolean handles(Object referent,
                Object... params)

Parameters:

referent - - potential referent to test

params - - potential parameter list to test

Returns:

True iff this RefProvider matches the given referent and parameters exactly.

makeRef

Reference makeRef(Object referent,
                  ReferenceQueue queue,
                  Object... params)

Parameters:

referent - - referent for the new reference

queue - - ReferenceQueue to enqueue the new reference

params - - list of parameters required by the new reference

Returns:

The created reference.