-
Notifications
You must be signed in to change notification settings - Fork 53
Expand file tree
/
Copy pathIOPlugin.java
More file actions
76 lines (65 loc) · 2.88 KB
/
IOPlugin.java
File metadata and controls
76 lines (65 loc) · 2.88 KB
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
/*
* #%L
* SciJava Common shared library for SciJava software.
* %%
* Copyright (C) 2009 - 2015 Board of Regents of the University of
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
* Institute of Molecular Cell Biology and Genetics.
* %%
* 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.
* #L%
*/
package org.scijava.io;
import java.io.IOException;
import org.scijava.plugin.HandlerPlugin;
import org.scijava.plugin.Plugin;
/**
* A plugin which extends an application's I/O capabilities.
* <p>
* I/O plugins discoverable at runtime must implement this interface and be
* annotated with @{@link Plugin} with attribute {@link Plugin#type()} =
* {@link IOPlugin}.class. While it possible to create an I/O plugin merely by
* implementing this interface, it is encouraged to instead extend
* {@link AbstractIOPlugin}, for convenience.
* </p>
*
* @author Curtis Rueden
* @see Plugin
* @see IOService
*/
public interface IOPlugin<D> extends HandlerPlugin<String> {
/** The type of data opened and/or saved by the plugin. */
Class<D> getDataType();
/** Checks whether the I/O plugin can open data from the given source. */
boolean supportsOpen(String source);
/** Checks whether the I/O plugin can save data to the given destination. */
boolean supportsSave(String destination);
/**
* Checks whether the I/O plugin can save the given data to the specified
* destination.
*/
boolean supportsSave(Object data, String destination);
/** Opens data from the given source. */
D open(String source) throws IOException;
/** Saves the given data to the specified destination. */
void save(D data, String destination) throws IOException;
}