-
Notifications
You must be signed in to change notification settings - Fork 53
Expand file tree
/
Copy pathPTService.java
More file actions
116 lines (106 loc) · 4.35 KB
/
Copy pathPTService.java
File metadata and controls
116 lines (106 loc) · 4.35 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
/*
* #%L
* SciJava Common shared library for SciJava software.
* %%
* Copyright (C) 2009 - 2026 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.plugin;
import java.util.List;
import org.scijava.service.Service;
/**
* A service for managing a particular sort of {@link SciJavaPlugin}.
* <p>
* There are many kinds of services, but most of them share one common
* characteristic: they provide API specific to a particular type of plugin. A
* few examples:
* </p>
* <ul>
* <li>The {@link org.scijava.command.CommandService} works with
* {@link org.scijava.command.Command}s.</li>
* <li>The {@link org.scijava.text.TextService} works with
* {@link org.scijava.text.TextFormat}s.</li>
* <li>The {@link org.scijava.platform.PlatformService} works with
* {@link org.scijava.platform.Platform}s.</li>
* </ul>
* <p>
* Most services fit this pattern in one way or another. When you wish to
* provide a new extensibility point, you create a new type of
* {@link SciJavaPlugin}, and a corresponding {@link PTService} for working with
* it. Depending on the nature of your new plugin type, this service might be:
* </p>
* <ul>
* <li>A {@link SingletonService}, such as
* {@link org.scijava.platform.PlatformService}, which manages
* {@link SingletonPlugin}s.</li>
* <li>A {@link HandlerService}, such as {@link org.scijava.text.TextService},
* which manages {@link HandlerPlugin}s.</li>
* <li>A {@link WrapperService}, such as
* {@link org.scijava.widget.WidgetService}, which manages
* {@link WrapperPlugin}s.</li>
* </ul>
* <p>
* It is named {@code PTService} rather than {@code PluginTypeService} or
* similar to avoid confusion with A) the {@link PluginService} itself, and B)
* any other service interface intended to define the API of a concrete service.
* In contrast to such services, the {@code PTService} is a more general layer
* in a type hierarchy intended to ease creation of services that fit its
* pattern.
* </p>
*
* @author Curtis Rueden
* @param <PT> Plugin type of the plugins being managed.
* @see SingletonService
* @see TypedService
* @see WrapperService
*/
public interface PTService<PT extends SciJavaPlugin> extends Service {
/**
* Gets the service responsible for discovering and managing this service's
* plugins.
*/
default PluginService pluginService() {
return context().getService(PluginService.class);
}
/** Gets the type of plugins managed by this service. */
Class<PT> getPluginType();
/** Gets the plugins managed by this service. */
default List<PluginInfo<PT>> getPlugins() {
return pluginService().getPluginsOfType(getPluginType());
}
/** Creates an instance of the given plugin class. */
default <P extends PT> P create(final Class<P> pluginClass) {
final PluginInfo<PT> info =
pluginService().getPlugin(pluginClass, getPluginType());
@SuppressWarnings("unchecked")
final P plugin = (P) pluginService().createInstance(info);
return plugin;
}
// -- Deprecated methods --
/** @deprecated Use {@link #pluginService()} instead. */
@Deprecated
default PluginService getPluginService() {
return pluginService();
}
}