-
Notifications
You must be signed in to change notification settings - Fork 53
Expand file tree
/
Copy pathIOService.java
More file actions
160 lines (145 loc) · 5.31 KB
/
Copy pathIOService.java
File metadata and controls
160 lines (145 loc) · 5.31 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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/*
* #%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 org.scijava.io.location.Location;
import org.scijava.plugin.HandlerService;
import org.scijava.service.SciJavaService;
/**
* Interface for high-level data I/O: opening and saving data.
*
* @author Curtis Rueden
*/
public interface IOService extends HandlerService<Location, IOPlugin<?>>,
SciJavaService
{
/**
* Gets the most appropriate {@link IOPlugin} for opening data from the given
* location.
*/
IOPlugin<?> getOpener(final String source) throws IOException;
/**
* Gets the most appropriate {@link IOPlugin} for opening data from the given
* location.
*/
default IOPlugin<?> getOpener(Location source) {
for (final IOPlugin<?> handler : getInstances()) {
if (handler.supportsOpen(source)) return handler;
}
return null;
}
/**
* Gets the most appropriate {@link IOPlugin} for saving data to the given
* location.
*/
<D> IOPlugin<D> getSaver(final D data, final String destination) throws IOException;
/**
* Gets the most appropriate {@link IOPlugin} for saving data to the given
* location.
*/
default <D> IOPlugin<D> getSaver(D data, Location destination) {
for (final IOPlugin<?> handler : getInstances()) {
if (handler.supportsSave(data, destination)) {
@SuppressWarnings("unchecked")
final IOPlugin<D> typedHandler = (IOPlugin<D>) handler;
return typedHandler;
}
}
return null;
}
/**
* Loads data from the given source. For extensibility, the nature of the
* source is left intentionally general, but two common examples include file
* paths and URLs.
* <p>
* The opener to use is automatically determined based on available
* {@link IOPlugin}s; see {@link #getOpener(String)}.
* </p>
*
* @param source The source (e.g., file path) from which to data should be
* loaded.
* @return An object representing the loaded data, or null if the source is
* not supported.
* @throws IOException if something goes wrong loading the data.
*/
Object open(String source) throws IOException;
/**
* Loads data from the given location.
* <p>
* The opener to use is automatically determined based on available
* {@link IOPlugin}s; see {@link #getOpener(Location)}.
* </p>
*
* @param source The location from which to data should be loaded.
* @return An object representing the loaded data, or null if the source is
* not supported.
* @throws IOException if something goes wrong loading the data.
*/
default Object open(Location source) throws IOException {
throw new UnsupportedOperationException();
}
/**
* Saves data to the given destination. The nature of the destination is left
* intentionally general, but the most common example is a file path.
* <p>
* The saver to use is automatically determined based on available
* {@link IOPlugin}s; see {@link #getSaver(Object, String)}.
* </p>
*
* @param data The data to be saved to the destination.
* @param destination The destination (e.g., file path) to which data should
* be saved.
* @throws IOException if something goes wrong saving the data.
*/
void save(Object data, String destination) throws IOException;
/**
* Saves data to the given location.
* <p>
* The saver to use is automatically determined based on available
* {@link IOPlugin}s; see {@link #getSaver(Object, Location)}.
* </p>
*
* @param data The data to be saved to the destination.
* @param destination The destination location to which data should be saved.
* @throws IOException if something goes wrong saving the data.
*/
default void save(Object data, Location destination) throws IOException {
throw new UnsupportedOperationException();
}
// -- HandlerService methods --
@Override
@SuppressWarnings({ "rawtypes", "unchecked" })
default Class<IOPlugin<?>> getPluginType() {
return (Class) IOPlugin.class;
}
@Override
default Class<Location> getType() {
return Location.class;
}
}