io.scif.filters

Class AbstractFilter<T>

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.filters.AbstractFilter<T>

Type Parameters:

T - - Parent type of this filter.

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractReaderFilter, MasterFilterHelper

public abstract class AbstractFilter<T>
extends AbstractSCIFIOPlugin
implements Filter

Abstract superclass for Filter implementations.

NB: the Prioritized.compareTo(org.scijava.Prioritized) implementation provided produces a natural ordering in descending order of AbstractRichPlugin.getPriority().

NB: the setParent(Object) method can not be typed narrowed with generics due to erasure. Type checking is performed during this call, however, to guarantee type safety for the cached parent instance. An IllegalArgumentException will be thrown if provided the wrong type of parent for this filter.

Author:

Mark Hiner

See Also:

Filter

Constructor Summary

Constructors

Constructor and Description
AbstractFilter(Class<? extends T> parentClass)

Method Summary

Modifier and Type	Method and Description
boolean	enabledDefault()
T	getParent() Returns the object this filter augments.
boolean	isCompatible(Class<?> c) Returns true if this filter is capable of wrapping instances of the provided class.
void	reset() Clears any configuration performed on this filter.
void	setParent(Object parent) Sets the object which this filter augments.

Methods inherited from class io.scif.AbstractSCIFIOPlugin

getVersion, log

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 io.scif.filters.Filter

target

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

Constructor Detail

AbstractFilter

public AbstractFilter(Class<? extends T> parentClass)

Method Detail

enabledDefault

public boolean enabledDefault()

Specified by:

enabledDefault in interface Filter

Returns:

True iff this filter should be enabled by default (e.g. whenever a ReaderFilter is constructed)

getParent

public T getParent()

Description copied from interface: Filter

Returns the object this filter augments.

Specified by:

getParent in interface Filter

Returns:

The object wrapped by this filter

setParent

public void setParent(Object parent)

Description copied from interface: Filter

Sets the object which this filter augments.

Specified by:

setParent in interface Filter

Parameters:

parent - - The object wrapped by this filter

reset

public void reset()

Description copied from interface: Filter

Clears any configuration performed on this filter.

Specified by:

reset in interface Filter

isCompatible

public boolean isCompatible(Class<?> c)

Description copied from interface: Filter

Returns true if this filter is capable of wrapping instances of the provided class.

Specified by:

isCompatible in interface Filter

Parameters:

c - - Class to check compatibility

Returns:

True if this filter can call setParent on instances of c