forked from scijava/scijava-common
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathGateway.java
More file actions
211 lines (174 loc) · 6.71 KB
/
Gateway.java
File metadata and controls
211 lines (174 loc) · 6.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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/*
* #%L
* SciJava Common shared library for SciJava software.
* %%
* Copyright (C) 2009 - 2014 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;
import org.scijava.app.App;
import org.scijava.app.AppService;
import org.scijava.app.StatusService;
import org.scijava.command.CommandService;
import org.scijava.console.ConsoleService;
import org.scijava.display.DisplayService;
import org.scijava.event.EventHistory;
import org.scijava.event.EventService;
import org.scijava.input.InputService;
import org.scijava.io.IOService;
import org.scijava.io.RecentFileService;
import org.scijava.log.LogService;
import org.scijava.menu.MenuService;
import org.scijava.module.ModuleService;
import org.scijava.object.ObjectService;
import org.scijava.options.OptionsService;
import org.scijava.platform.AppEventService;
import org.scijava.platform.PlatformService;
import org.scijava.plugin.Plugin;
import org.scijava.plugin.PluginService;
import org.scijava.plugin.RichPlugin;
import org.scijava.script.ScriptService;
import org.scijava.service.Service;
import org.scijava.text.TextService;
import org.scijava.thread.ThreadService;
import org.scijava.tool.IconService;
import org.scijava.tool.ToolService;
import org.scijava.widget.WidgetService;
/**
* Interface for convenience classes that wrap a {@link Context} to provide
* one-line access to a suite of {@link Service}s.
* <p>
* The {@link #get} methods provide consistent {@link Service} instantiation,
* while throwing {@link NoSuchServiceException} if the requested
* {@link Service} is not found.
* </p>
* <h3>Sample implementation</h3>
* <p>
* Let's say we have a {@code Kraken} service and a {@code Cow} service. Using
* the {@code Context} directly, the code would look like:
* </p>
* <pre>
* Context context = new Context();
* context.getService(Cow.class).feedToKraken();
* context.getService(Kraken.class).burp();</pre>
* <p>
* To perform these actions, you have to know <em>a priori</em> to ask for a
* {@code Cow} and a {@code Kraken}; i.e., your IDE's code completion will not
* give you a hint. Further, if either service is unavailable, a
* {@link NullPointerException} is thrown.
* </p>
* <p>
* But if we create a {@code Gateway} class called {@code Animals} with the
* following signatures:
* </p>
* <pre>
* public Cow cow() { return get(Cow.class); }
* public Kraken kraken() { return get(Kraken.class); }</pre>
* <p>
* We can now access our services through the new {@code Animals} gateway:
* </p>
* <pre>
* Animals animals = new Animals();
* animals.cow().feedToKraken();
* animals.kraken().burp();</pre>
* <p>
* This provides succinct yet explicit access to the {@code Cow} and
* {@code Kraken} services; it is a simple two-layer access to functionality,
* which an IDE can auto-complete. And if one of the services is not available,
* a {@link NoSuchServiceException} is thrown, which facilitates appropriate
* (but optional) handling of missing services.
* </p>
* <p>
* Gateways discoverable at runtime must implement this interface and be
* annotated with @{@link Gateway} with attribute {@link Plugin#type()} =
* {@link Gateway}.class. While it possible to create a gateway merely by
* implementing this interface, it is encouraged to instead extend
* {@link AbstractGateway}, for convenience.
* </p>
*
* @see Context
* @author Mark Hiner
* @author Curtis Rueden
*/
public interface Gateway extends RichPlugin, Versioned {
/**
* Returns an implementation of the requested {@link Service}, if it exists in
* the underlying {@link Context}.
*
* @param serviceClass the requested {@link Service}
* @return The singleton instance of the given class
* @throws NullContextException if the application context is not set.
* @throws NoSuchServiceException if there is no service of the given class.
*/
<S extends Service> S get(Class<S> serviceClass);
/**
* Returns an implementation of the {@link Service} with the given class name,
* if it exists in the underlying {@link Context}.
*
* @param serviceClassName name of the requested {@link Service}
* @return The singleton instance of the requested {@link Service}
* @throws NullContextException if the application context is not set.
* @throws NoSuchServiceException if there is no service matching
* {@code serviceClassName}.
*/
Service get(final String serviceClassName);
// -- Gateway methods - services --
AppEventService appEvent();
AppService app();
CommandService command();
ConsoleService console();
DisplayService display();
EventHistory eventHistory();
EventService event();
IconService icon();
InputService input();
IOService io();
LogService log();
MenuService menu();
ModuleService module();
ObjectService object();
OptionsService options();
PlatformService platform();
PluginService plugin();
RecentFileService recentFile();
ScriptService script();
StatusService status();
TextService text();
ThreadService thread();
ToolService tool();
WidgetService widget();
// -- Gateway methods - application --
/** @see org.scijava.app.AppService */
App getApp();
/** @see org.scijava.app.App#getTitle() */
String getTitle();
/** @see org.scijava.app.App#getInfo(boolean) */
String getInfo(boolean mem);
// -- Versioned methods --
/** @see org.scijava.app.App#getVersion() */
@Override
String getVersion();
}