Package org.scijava.convert

Class AbstractConverter<I,O>

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.plugin.AbstractTypedPlugin<D>

org.scijava.plugin.AbstractHandlerPlugin<ConversionRequest>

org.scijava.convert.AbstractConverter<I,O>

All Implemented Interfaces:

Comparable<Prioritized>, Contextual, Converter<I,O>, Identifiable, Locatable, Logged, HandlerPlugin<ConversionRequest>, HasPluginInfo, RichPlugin, SciJavaPlugin, SingletonPlugin, TypedPlugin<ConversionRequest>, Prioritized, Typed<ConversionRequest>, Versioned

Direct Known Subclasses:

AbstractDelegateConverter, ArrayToStringConverter, CastingConverter, DefaultConverter, FileListConverters.FileArrayToStringConverter, FileListConverters.FileToStringConverter, FileListConverters.StringToFileArrayConverter, FileListConverters.StringToFileConverter, FileToPathConverter, NullConverter, NumberToNumberConverter, PathToFileConverter, PrimitiveArrayUnwrapper, PrimitiveArrayWrapper, StringToArrayConverter, StringToNumberConverter

public abstract class AbstractConverter<I,O>
extends AbstractHandlerPlugin<ConversionRequest>
implements Converter<I,O>

Abstract superclass for Converter plugins. Performs appropriate dispatching of Converter.canConvert(ConversionRequest) and Converter.convert(ConversionRequest) calls based on the actual state of the given ConversionRequest.

Author:

Mark Hiner

Constructor Summary

Constructors

Constructor	Description
AbstractConverter()

Method Summary

Modifier and Type	Method	Description
void	populateInputCandidates(Collection<Object> objects)	Populates the given collection with objects which are known to exist, and which are usable as inputs for this converter.
boolean	supports(ConversionRequest request)	Gets whether this object is compatible with the given data object.

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority, toString

Methods inherited from class org.scijava.AbstractContextual

context, getContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.convert.Converter

canConvert, canConvert, canConvert, canConvert, canConvert, convert, convert, convert, getInputType, getOutputType, getType

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Versioned

getVersion

Constructor Detail

AbstractConverter

public AbstractConverter()

Method Detail

populateInputCandidates

public void populateInputCandidates(Collection<Object> objects)

Description copied from interface: Converter

Populates the given collection with objects which are known to exist, and which are usable as inputs for this converter.

That is: each such object added to the collection would return true if queried with converter.canConvert(object), and hence would produce an output of type Converter.getOutputType() if passed to converter.convert(object).

The means by which "known objects" are determined is implementation dependent, although the most typical use case is to query the ObjectService for known objects of type Converter.getInputType(), and return those. But other behaviors are possible, depending on the converter implementation.

Specified by:

populateInputCandidates in interface Converter<I,O>

Parameters:

objects - an initialized collection into which appropriate objects will be inserted.

supports

public boolean supports(ConversionRequest request)

Description copied from interface: Typed

Gets whether this object is compatible with the given data object.

By default, this method will return true iff the data is assignable to the associated type given by Typed.getType(). But individual implementations may have other requirements beyond class assignability.

Specified by:

supports in interface Converter<I,O>

Specified by:

supports in interface Typed<I>

Overrides:

supports in class AbstractTypedPlugin<ConversionRequest>