blob: a3bdceb2a27e311db6e12ffaaa9bc3823b35d8b5 (
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
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
|
/*
* This file is part of spark.
*
* Copyright (c) lucko (Luck) <luck@lucko.me>
* Copyright (c) contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package me.lucko.spark.common;
import me.lucko.spark.api.Spark;
import me.lucko.spark.common.command.sender.CommandSender;
import me.lucko.spark.common.monitor.ping.PlayerPingProvider;
import me.lucko.spark.common.monitor.tick.TickStatistics;
import me.lucko.spark.common.platform.MetadataProvider;
import me.lucko.spark.common.platform.PlatformInfo;
import me.lucko.spark.common.platform.serverconfig.ServerConfigProvider;
import me.lucko.spark.common.platform.world.WorldInfoProvider;
import me.lucko.spark.common.sampler.ThreadDumper;
import me.lucko.spark.common.sampler.source.ClassSourceLookup;
import me.lucko.spark.common.sampler.source.SourceMetadata;
import me.lucko.spark.common.tick.TickHook;
import me.lucko.spark.common.tick.TickReporter;
import java.nio.file.Path;
import java.util.Collection;
import java.util.Collections;
import java.util.logging.Level;
import java.util.stream.Stream;
/**
* Spark plugin interface
*/
public interface SparkPlugin {
/**
* Gets the version of the plugin.
*
* @return the version
*/
String getVersion();
/**
* Gets the plugins storage/configuration directory.
*
* @return the plugin directory
*/
Path getPluginDirectory();
/**
* Gets the name used for the plugin command.
*
* @return the plugin command name
*/
String getCommandName();
/**
* Gets a {@link Stream} of the {@link CommandSender}s on the platform.
*
* @return the stream of command senders
*/
Stream<? extends CommandSender> getCommandSenders();
/**
* Executes the given {@link Runnable} asynchronously using the plugins scheduler.
*
* @param task the task
*/
void executeAsync(Runnable task);
/**
* Executes the given {@link Runnable} on the server/client main thread.
*
* @param task the task
*/
default void executeSync(Runnable task) {
throw new UnsupportedOperationException();
}
/**
* Print to the plugin logger.
*
* @param level the log level
* @param msg the message
*/
void log(Level level, String msg);
/**
* Gets the default {@link ThreadDumper} to be used by the plugin.
*
* @return the default thread dumper
*/
default ThreadDumper getDefaultThreadDumper() {
return ThreadDumper.ALL;
}
/**
* Creates a tick hook for the platform, if supported.
*
* <p>Returns {@code null} if the platform does not have "ticks"</p>
*
* @return a new tick hook
*/
default TickHook createTickHook() {
return null;
}
/**
* Creates a tick reporter for the platform, if supported.
*
* <p>Returns {@code null} if the platform does not have "ticks"</p>
*
* @return a new tick reporter
*/
default TickReporter createTickReporter() {
return null;
}
/**
* Creates tick statistics for the platform, if supported.
*
* <p>Spark is able to provide a default implementation for platforms that
* provide a {@link TickHook} and {@link TickReporter}.</p>
*
* @return a new tick statistics instance
*/
default TickStatistics createTickStatistics() {
return null;
}
/**
* Creates a class source lookup function.
*
* @return the class source lookup function
*/
default ClassSourceLookup createClassSourceLookup() {
return ClassSourceLookup.NO_OP;
}
/**
* Gets a list of known sources (plugins/mods) on the platform.
*
* @return a list of sources
*/
default Collection<SourceMetadata> getKnownSources() {
return Collections.emptyList();
}
/**
* Creates a player ping provider function.
*
* <p>Returns {@code null} if the platform does not support querying player pings</p>
*
* @return the player ping provider function
*/
default PlayerPingProvider createPlayerPingProvider() {
return null;
}
/**
* Creates a server config provider.
*
* @return the server config provider function
*/
default ServerConfigProvider createServerConfigProvider() {
return null;
}
/**
* Creates a metadata provider for the platform.
*
* @return the platform extra metadata provider
*/
default MetadataProvider createExtraMetadataProvider() {
return null;
}
/**
* Creates a world info provider.
*
* @return the world info provider function
*/
default WorldInfoProvider createWorldInfoProvider() {
return WorldInfoProvider.NO_OP;
}
/**
* Gets information for the platform.
*
* @return information about the platform
*/
PlatformInfo getPlatformInfo();
default void registerApi(Spark api) {
}
}
|
