blob: 5d45ffb24a22814a2cc3b58110477c03204a9737 (
plain)
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
|
package org.bukkit.plugin;
import java.util.Collection;
import java.util.List;
/**
* Manages services and service providers. Services are an interface
* specifying a list of methods that a provider must implement. Providers are
* implementations of these services. A provider can be queried from the
* services manager in order to use a service (if one is available). If
* multiple plugins register a service, then the service with the highest
* priority takes precedence.
*/
public interface ServicesManager {
/**
* Register a provider of a service.
*
* @param <T> Provider
* @param service service class
* @param provider provider to register
* @param plugin plugin with the provider
* @param priority priority of the provider
*/
public <T> void register(Class<T> service, T provider, Plugin plugin, ServicePriority priority);
/**
* Unregister all the providers registered by a particular plugin.
*
* @param plugin The plugin
*/
public void unregisterAll(Plugin plugin);
/**
* Unregister a particular provider for a particular service.
*
* @param service The service interface
* @param provider The service provider implementation
*/
public void unregister(Class<?> service, Object provider);
/**
* Unregister a particular provider.
*
* @param provider The service provider implementation
*/
public void unregister(Object provider);
/**
* Queries for a provider. This may return if no provider has been
* registered for a service. The highest priority provider is returned.
*
* @param <T> The service interface
* @param service The service interface
* @return provider or null
*/
public <T> T load(Class<T> service);
/**
* Queries for a provider registration. This may return if no provider
* has been registered for a service.
*
* @param <T> The service interface
* @param service The service interface
* @return provider registration or null
*/
public <T> RegisteredServiceProvider<T> getRegistration(Class<T> service);
/**
* Get registrations of providers for a plugin.
*
* @param plugin The plugin
* @return provider registration or null
*/
public List<RegisteredServiceProvider<?>> getRegistrations(Plugin plugin);
/**
* Get registrations of providers for a service. The returned list is
* unmodifiable.
*
* @param <T> The service interface
* @param service The service interface
* @return list of registrations
*/
public <T> Collection<RegisteredServiceProvider<T>> getRegistrations(Class<T> service);
/**
* Get a list of known services. A service is known if it has registered
* providers for it.
*
* @return list of known services
*/
public Collection<Class<?>> getKnownServices();
/**
* Returns whether a provider has been registered for a service. Do not
* check this first only to call <code>load(service)</code> later, as that
* would be a non-thread safe situation.
*
* @param <T> service
* @param service service to check
* @return whether there has been a registered provider
*/
public <T> boolean isProvidedFor(Class<T> service);
}
|
