Repository navigation
Expand file tree
/
Copy pathIOPlugin.java
More file actions
141 lines (123 loc) · 4.71 KB
/
Copy pathIOPlugin.java
File metadata and controls
141 lines (123 loc) · 4.71 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
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/*
* #%L
* SciJava Common shared library for SciJava software.
* %%
* Copyright (C) 2009 - 2023 SciJava developers.
* %%
* 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 java.net.URISyntaxException;
import org.scijava.io.location.Location;
import org.scijava.io.location.LocationService;
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<Location> {
/** 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. */
default boolean supportsOpen(final String source) {
try {
return supportsOpen(context().service(LocationService.class).resolve(source));
}
catch (final URISyntaxException exc) {
return false;
}
}
/** Checks whether the I/O plugin can open data from the given location. */
@SuppressWarnings("unused")
default boolean supportsOpen(final Location source) {
return false;
}
/** Checks whether the I/O plugin can save data to the given destination. */
default boolean supportsSave(final String destination) {
try {
return supportsSave(context().service(LocationService.class).resolve(destination));
}
catch (final URISyntaxException exc) {
return false;
}
}
/** Checks whether the I/O plugin can save data to the given location. */
@SuppressWarnings("unused")
default boolean supportsSave(final Location destination) {
return false;
}
/**
* Checks whether the I/O plugin can save the given data to the specified
* location.
*/
default boolean supportsSave(final Object data, final String destination) {
return supportsSave(destination) && getDataType().isInstance(data);
}
default boolean supportsSave(final Object data, final Location destination) {
return supportsSave(destination) && getDataType().isInstance(data);
}
/** Opens data from the given source. */
@SuppressWarnings("unused")
default D open(final String source) throws IOException {
throw new UnsupportedOperationException();
}
/** Opens data from the given location. */
@SuppressWarnings("unused")
default D open(final Location source) throws IOException {
throw new UnsupportedOperationException();
}
/** Saves the given data to the specified destination. */
default void save(final D data, final String destination) throws IOException {
try {
save(data, context().service(LocationService.class).resolve(destination));
}
catch (final URISyntaxException exc) {
throw new UnsupportedOperationException(exc);
}
}
/** Saves the given data to the specified location. */
@SuppressWarnings("unused")
default void save(final D data, final Location destination) throws IOException {
throw new UnsupportedOperationException();
}
// -- Typed methods --
default boolean supports(final String descriptor) {
return supportsOpen(descriptor) || supportsSave(descriptor);
}
@Override
default Class<Location> getType() {
return Location.class;
}
}