io.scif.filters

Class MasterFilterHelper<T extends org.scijava.Contextual>

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.filters.AbstractFilter<T>

io.scif.filters.MasterFilterHelper<T>

All Implemented Interfaces:

Filter, MasterFilter<T>, 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

public class MasterFilterHelper<T extends org.scijava.Contextual>
extends AbstractFilter<T>
implements MasterFilter<T>

Helper class for MasterFilter implementations. Takes the place of an abstract superclass for containing boilerplate code.

As all MasterFilter implementations are also Filters, it makes sense for concrete implementations of the former to be free to inherit from abstract implementations of the latter. Thus, any boilerplate code that would be common to all MasterFilter implementations, regardless of their wrapped type, must go in a helper class to avoid multiple inheritance conflicts.

On construction, all Filter classes annotated with Plugin are discovered by the SciJava Common framework. All items whose wrappedClass() return the same class as was used to construct this MasterFilterHelper will be added to the list of filters for future use. Filters are initially enabled or disabled based on their isDefaultEnabled() annotation return value.

Filters can be enabled or disabled using the enable(Class) and disable(Class) methods. This process can be done in any order, as execution ordering of enabled filters is maintained automatically per their natural order.

Author:

Mark Hiner

See Also:

MasterFilter, Filter

Constructor Summary

Constructors

Constructor and Description
MasterFilterHelper(T wrapped, Class<? extends T> wrappedClass)

Method Summary

Modifier and Type	Method and Description
boolean	disable(Class<? extends Filter> filterClass) Removes the specified filter from the filter stack, if present.
<F extends Filter> F	enable(Class<F> filterClass) Inserts an instance of the indicated filter class into the filter stack.
Set<Class<? extends Filter>>	getFilterClasses() Returns a list of all filter classes this MasterFilter can enable/disable.
T	getTail() Returns the base object (below the filter stack).
void	reset() Clears any configuration performed on this filter.
Class<?>	target()

Methods inherited from class io.scif.filters.AbstractFilter

enabledDefault, getParent, isCompatible, setParent

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.MasterFilter

getParent, setParent

Methods inherited from interface io.scif.filters.Filter

enabledDefault, isCompatible

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

MasterFilterHelper

public MasterFilterHelper(T wrapped,
                          Class<? extends T> wrappedClass)

Method Detail

enable

public <F extends Filter> F enable(Class<F> filterClass)

Description copied from interface: MasterFilter

Inserts an instance of the indicated filter class into the filter stack. Returns the filter instance associated with this MasterFilter, which can be used for wrapper-specific configuration.

Specified by:

enable in interface MasterFilter<T extends org.scijava.Contextual>

Parameters:

filterClass - - The type of filter to enable

Returns:

The enabled filter

disable

public boolean disable(Class<? extends Filter> filterClass)

Description copied from interface: MasterFilter

Removes the specified filter from the filter stack, if present. Clears any state in the cached instance of the specified filter.

Specified by:

disable in interface MasterFilter<T extends org.scijava.Contextual>

Parameters:

filterClass - - The type of filter to disable

Returns:

true if the desired filter was disabled

getTail

public T getTail()

Description copied from interface: MasterFilter

Returns the base object (below the filter stack).

Specified by:

getTail in interface MasterFilter<T extends org.scijava.Contextual>

target

public Class<?> target()

Specified by:

target in interface Filter

Returns:

The target type operated on 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

Specified by:

reset in interface MasterFilter<T extends org.scijava.Contextual>

Overrides:

reset in class AbstractFilter<T extends org.scijava.Contextual>

getFilterClasses

public Set<Class<? extends Filter>> getFilterClasses()

Description copied from interface: MasterFilter

Returns a list of all filter classes this MasterFilter can enable/disable.

Specified by:

getFilterClasses in interface MasterFilter<T extends org.scijava.Contextual>

Returns:

A list of discovered filters