org.scijava.convert
Class AbstractConverter

java.lang.Object
  org.scijava.AbstractContextual
      org.scijava.plugin.AbstractRichPlugin
          org.scijava.plugin.AbstractTypedPlugin<D>
              org.scijava.plugin.AbstractHandlerPlugin<ConversionRequest>
                  org.scijava.convert.AbstractConverter

All Implemented Interfaces:

Comparable<Prioritized>, Contextual, Converter, HandlerPlugin<ConversionRequest>, HasPluginInfo, RichPlugin, SciJavaPlugin, SingletonPlugin, TypedPlugin<ConversionRequest>, Prioritized, Typed<ConversionRequest>

Direct Known Subclasses:

DefaultConverter

public abstract class AbstractConverter
extends AbstractHandlerPlugin<ConversionRequest>
implements Converter

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

Note that the supports(ConversionRequest) method is overridden as well, to delegate to the appropriate canConvert(org.scijava.convert.ConversionRequest).

Author:

Mark Hiner

Constructor Summary

AbstractConverter()

Method Summary

boolean	canConvert(ConversionRequest request) Checks whether a given can be processed, by converting the desired ConversionRequest.sourceClass() to its ConversionRequest.destClass() or ConversionRequest.destType().
Object	convert(ConversionRequest request) Converts the given ConversionRequest.sourceObject() to the specified ConversionRequest.destClass() or ConversionRequest.destType().
Class<ConversionRequest>	getType() Gets the type associated with the object.
boolean	supports(ConversionRequest request) Gets whether this object is compatible with the given data object.

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

compareTo, getInfo, getPriority, setInfo, setPriority, toString

Methods inherited from class org.scijava.AbstractContextual

context, getContext, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scijava.convert.Converter

canConvert, canConvert, canConvert, canConvert, convert, convert

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

getPriority, setPriority

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Constructor Detail

AbstractConverter

public AbstractConverter()

Method Detail

canConvert

public boolean canConvert(ConversionRequest request)

Description copied from interface: Converter

Checks whether a given can be processed, by converting the desired ConversionRequest.sourceClass() to its ConversionRequest.destClass() or ConversionRequest.destType().

Specified by:

canConvert in interface Converter

See Also:

Converter.convert(ConversionRequest)

convert

public Object convert(ConversionRequest request)

Description copied from interface: Converter

Converts the given ConversionRequest.sourceObject() to the specified ConversionRequest.destClass() or ConversionRequest.destType().

Specified by:

convert in interface Converter

Parameters:

request - ConversionRequest to process.

Returns:

The conversion output

See Also:

Converter.convert(Object, Class), Converter.convert(Object, Type)

supports

public boolean supports(ConversionRequest request)

Description copied from interface: Typed

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

Typically, this will be the case when data.getClass() is assignable to the type associated with the object (i.e., the one returned by Typed.getType()). But individual implementations may have other requirements beyond class assignability.

Specified by:

supports in interface Typed<ConversionRequest>

Overrides:

supports in class AbstractTypedPlugin<ConversionRequest>

getType

public Class<ConversionRequest> getType()

Description copied from interface: Typed

Gets the type associated with the object.

Specified by:

getType in interface Typed<ConversionRequest>