-
Notifications
You must be signed in to change notification settings - Fork 37
/
AbstractFilter.java
109 lines (95 loc) · 3.49 KB
/
AbstractFilter.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/*
* #%L
* SCIFIO library for reading and converting scientific file formats.
* %%
* Copyright (C) 2011 - 2013 Open Microscopy Environment:
* - Board of Regents of the University of Wisconsin-Madison
* - Glencoe Software, Inc.
* - University of Dundee
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are
* those of the authors and should not be interpreted as representing official
* policies, either expressed or implied, of any organization.
* #L%
*/
package io.scif.filters;
import io.scif.AbstractSCIFIOPlugin;
/**
* Abstract superclass for {@link io.scif.filters.Filter} implementations.
* <p>
* NB: the {@link #compareTo(org.scijava.Prioritized)} implementation provided
* produces a natural ordering in descending order of {@link #getPriority()}.
* </p>
* <p>
* NB: the {@link #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
* {@link IllegalArgumentException} will be thrown if provided the wrong type of
* parent for this filter.
* </p>
*
* @author Mark Hiner
* @see io.scif.filters.Filter
* @param <T> - Parent type of this filter.
*/
public abstract class AbstractFilter<T> extends AbstractSCIFIOPlugin
implements Filter
{
// -- Fields --
/* Parent to delegate to. */
private T parent = null;
/* For checking in setParent */
private final Class<? extends T> parentClass;
// -- Constructor --
public AbstractFilter(final Class<? extends T> parentClass) {
this.parentClass = parentClass;
}
// -- Filter API Methods --
@Override
public boolean enabledDefault() {
return false;
}
@Override
public T getParent() {
return parent;
}
@Override
@SuppressWarnings("unchecked")
public void setParent(final Object parent) {
if (parentClass.isAssignableFrom(parent.getClass())) this.parent =
(T) parent;
else {
throw new IllegalArgumentException("Invalid parent. Provided: " +
parent.getClass() + " Expected: " + parentClass);
}
}
@Override
public void reset() {
parent = null;
}
@Override
public boolean isCompatible(final Class<?> c) {
return parentClass.isAssignableFrom(c);
}
}