twin/paper-mc
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-08-17 13:24:17 -07:00
Code Issues Packages Projects Releases Wiki Activity

Add Override annotations where appropriate

Browse Source 
By: md_5 <git@md-5.net>
This commit is contained in:
Bukkit/Spigot
2019-04-28 11:37:52 +10:00
parent d66310a2f1
commit 82854b7bd7
176 changed files with 503 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
paper-api/src/main/java/org/bukkit/plugin/PluginBase.java
View File

@@ -28,6 +28,7 @@ public abstract class PluginBase implements Plugin {
return getName().equals(((Plugin) obj).getName());
}
@Override
@NotNull
public final String getName() {
return getDescription().getName();

1
paper-api/src/main/java/org/bukkit/plugin/RegisteredServiceProvider.java
View File

@@ -41,6 +41,7 @@ public class RegisteredServiceProvider<T> implements Comparable<RegisteredServic
return priority;
}
@Override
public int compareTo(@NotNull RegisteredServiceProvider<?> other) {
if (priority.ordinal() == other.getPriority().ordinal()) {
return 0;

29
paper-api/src/main/java/org/bukkit/plugin/SimplePluginManager.java
View File

@@ -66,6 +66,7 @@ public final class SimplePluginManager implements PluginManager {
* @throws IllegalArgumentException Thrown when the given Class is not a
* valid PluginLoader
*/
@Override
public void registerInterface(@NotNull Class<? extends PluginLoader> loader) throws IllegalArgumentException {
PluginLoader instance;
@@ -101,6 +102,7 @@ public final class SimplePluginManager implements PluginManager {
* @param directory Directory to check for plugins
* @return A list of all plugins loaded
*/
@Override
@NotNull
public Plugin[] loadPlugins(@NotNull File directory) {
Validate.notNull(directory, "Directory cannot be null");
@@ -310,6 +312,7 @@ public final class SimplePluginManager implements PluginManager {
* @throws UnknownDependencyException If a required dependency could not
* be found
*/
@Override
@Nullable
public synchronized Plugin loadPlugin(@NotNull File file) throws InvalidPluginException, UnknownDependencyException {
Validate.notNull(file, "File cannot be null");
@@ -357,11 +360,13 @@ public final class SimplePluginManager implements PluginManager {
* @param name Name of the plugin to check
* @return Plugin if it exists, otherwise null
*/
@Override
@Nullable
public synchronized Plugin getPlugin(@NotNull String name) {
return lookupNames.get(name.replace(' ', '_'));
}
@Override
@NotNull
public synchronized Plugin[] getPlugins() {
return plugins.toArray(new Plugin[plugins.size()]);
@@ -375,6 +380,7 @@ public final class SimplePluginManager implements PluginManager {
* @param name Name of the plugin to check
* @return true if the plugin is enabled, otherwise false
*/
@Override
public boolean isPluginEnabled(@NotNull String name) {
Plugin plugin = getPlugin(name);
@@ -387,6 +393,7 @@ public final class SimplePluginManager implements PluginManager {
* @param plugin Plugin to check
* @return true if the plugin is enabled, otherwise false
*/
@Override
public boolean isPluginEnabled(@Nullable Plugin plugin) {
if ((plugin != null) && (plugins.contains(plugin))) {
return plugin.isEnabled();
@@ -395,6 +402,7 @@ public final class SimplePluginManager implements PluginManager {
}
}
@Override
public void enablePlugin(@NotNull final Plugin plugin) {
if (!plugin.isEnabled()) {
List<Command> pluginCommands = PluginCommandYamlParser.parse(plugin);
@@ -413,6 +421,7 @@ public final class SimplePluginManager implements PluginManager {
}
}
@Override
public void disablePlugins() {
Plugin[] plugins = getPlugins();
for (int i = plugins.length - 1; i >= 0; i--) {
@@ -420,6 +429,7 @@ public final class SimplePluginManager implements PluginManager {
}
}
@Override
public void disablePlugin(@NotNull final Plugin plugin) {
if (plugin.isEnabled()) {
try {
@@ -455,6 +465,7 @@ public final class SimplePluginManager implements PluginManager {
}
}
@Override
public void clearPlugins() {
synchronized (this) {
disablePlugins();
@@ -475,6 +486,7 @@ public final class SimplePluginManager implements PluginManager {
*
* @param event Event details
*/
@Override
public void callEvent(@NotNull Event event) {
if (event.isAsynchronous()) {
if (Thread.holdsLock(this)) {
@@ -524,6 +536,7 @@ public final class SimplePluginManager implements PluginManager {
}
}
@Override
public void registerEvents(@NotNull Listener listener, @NotNull Plugin plugin) {
if (!plugin.isEnabled()) {
throw new IllegalPluginAccessException("Plugin attempted to register " + listener + " while not enabled");
@@ -535,6 +548,7 @@ public final class SimplePluginManager implements PluginManager {
}
@Override
public void registerEvent(@NotNull Class<? extends Event> event, @NotNull Listener listener, @NotNull EventPriority priority, @NotNull EventExecutor executor, @NotNull Plugin plugin) {
registerEvent(event, listener, priority, executor, plugin, false);
}
@@ -551,6 +565,7 @@ public final class SimplePluginManager implements PluginManager {
* @param ignoreCancelled Do not call executor if event was already
* cancelled
*/
@Override
public void registerEvent(@NotNull Class<? extends Event> event, @NotNull Listener listener, @NotNull EventPriority priority, @NotNull EventExecutor executor, @NotNull Plugin plugin, boolean ignoreCancelled) {
Validate.notNull(listener, "Listener cannot be null");
Validate.notNull(priority, "Priority cannot be null");
@@ -595,11 +610,13 @@ public final class SimplePluginManager implements PluginManager {
}
}
@Override
@Nullable
public Permission getPermission(@NotNull String name) {
return permissions.get(name.toLowerCase(java.util.Locale.ENGLISH));
}
@Override
public void addPermission(@NotNull Permission perm) {
addPermission(perm, true);
}
@@ -616,19 +633,23 @@ public final class SimplePluginManager implements PluginManager {
calculatePermissionDefault(perm, dirty);
}
@Override
@NotNull
public Set<Permission> getDefaultPermissions(boolean op) {
return ImmutableSet.copyOf(defaultPerms.get(op));
}
@Override
public void removePermission(@NotNull Permission perm) {
removePermission(perm.getName());
}
@Override
public void removePermission(@NotNull String name) {
permissions.remove(name.toLowerCase(java.util.Locale.ENGLISH));
}
@Override
public void recalculatePermissionDefaults(@NotNull Permission perm) {
if (perm != null && permissions.containsKey(perm.getName().toLowerCase(java.util.Locale.ENGLISH))) {
defaultPerms.get(true).remove(perm);
@@ -667,6 +688,7 @@ public final class SimplePluginManager implements PluginManager {
}
}
@Override
public void subscribeToPermission(@NotNull String permission, @NotNull Permissible permissible) {
String name = permission.toLowerCase(java.util.Locale.ENGLISH);
Map<Permissible, Boolean> map = permSubs.get(name);
@@ -679,6 +701,7 @@ public final class SimplePluginManager implements PluginManager {
map.put(permissible, true);
}
@Override
public void unsubscribeFromPermission(@NotNull String permission, @NotNull Permissible permissible) {
String name = permission.toLowerCase(java.util.Locale.ENGLISH);
Map<Permissible, Boolean> map = permSubs.get(name);
@@ -692,6 +715,7 @@ public final class SimplePluginManager implements PluginManager {
}
}
@Override
@NotNull
public Set<Permissible> getPermissionSubscriptions(@NotNull String permission) {
String name = permission.toLowerCase(java.util.Locale.ENGLISH);
@@ -704,6 +728,7 @@ public final class SimplePluginManager implements PluginManager {
}
}
@Override
public void subscribeToDefaultPerms(boolean op, @NotNull Permissible permissible) {
Map<Permissible, Boolean> map = defSubs.get(op);
@@ -715,6 +740,7 @@ public final class SimplePluginManager implements PluginManager {
map.put(permissible, true);
}
@Override
public void unsubscribeFromDefaultPerms(boolean op, @NotNull Permissible permissible) {
Map<Permissible, Boolean> map = defSubs.get(op);
@@ -727,6 +753,7 @@ public final class SimplePluginManager implements PluginManager {
}
}
@Override
@NotNull
public Set<Permissible> getDefaultPermSubscriptions(boolean op) {
Map<Permissible, Boolean> map = defSubs.get(op);
@@ -738,11 +765,13 @@ public final class SimplePluginManager implements PluginManager {
}
}
@Override
@NotNull
public Set<Permission> getPermissions() {
return new HashSet<Permission>(permissions.values());
}
@Override
public boolean useTimings() {
return useTimings;
}

10
paper-api/src/main/java/org/bukkit/plugin/SimpleServicesManager.java
View File

@@ -35,6 +35,7 @@ public class SimpleServicesManager implements ServicesManager {
* @param plugin plugin with the provider
* @param priority priority of the provider
*/
@Override
public <T> void register(@NotNull Class<T> service, @NotNull T provider, @NotNull Plugin plugin, @NotNull ServicePriority priority) {
RegisteredServiceProvider<T> registeredProvider = null;
synchronized (providers) {
@@ -63,6 +64,7 @@ public class SimpleServicesManager implements ServicesManager {
*
* @param plugin The plugin
*/
@Override
public void unregisterAll(@NotNull Plugin plugin) {
ArrayList<ServiceUnregisterEvent> unregisteredEvents = new ArrayList<ServiceUnregisterEvent>();
synchronized (providers) {
@@ -105,6 +107,7 @@ public class SimpleServicesManager implements ServicesManager {
* @param service The service interface
* @param provider The service provider implementation
*/
@Override
public void unregister(@NotNull Class<?> service, @NotNull Object provider) {
ArrayList<ServiceUnregisterEvent> unregisteredEvents = new ArrayList<ServiceUnregisterEvent>();
synchronized (providers) {
@@ -152,6 +155,7 @@ public class SimpleServicesManager implements ServicesManager {
*
* @param provider The service provider implementation
*/
@Override
public void unregister(@NotNull Object provider) {
ArrayList<ServiceUnregisterEvent> unregisteredEvents = new ArrayList<ServiceUnregisterEvent>();
synchronized (providers) {
@@ -196,6 +200,7 @@ public class SimpleServicesManager implements ServicesManager {
* @param service The service interface
* @return provider or null
*/
@Override
@Nullable
public <T> T load(@NotNull Class<T> service) {
synchronized (providers) {
@@ -218,6 +223,7 @@ public class SimpleServicesManager implements ServicesManager {
* @param service The service interface
* @return provider registration or null
*/
@Override
@Nullable
@SuppressWarnings("unchecked")
public <T> RegisteredServiceProvider<T> getRegistration(@NotNull Class<T> service) {
@@ -239,6 +245,7 @@ public class SimpleServicesManager implements ServicesManager {
* @param plugin The plugin
* @return provider registrations
*/
@Override
@NotNull
public List<RegisteredServiceProvider<?>> getRegistrations(@NotNull Plugin plugin) {
ImmutableList.Builder<RegisteredServiceProvider<?>> ret = ImmutableList.<RegisteredServiceProvider<?>>builder();
@@ -262,6 +269,7 @@ public class SimpleServicesManager implements ServicesManager {
* @param service The service interface
* @return a copy of the list of registrations
*/
@Override
@NotNull
@SuppressWarnings("unchecked")
public <T> List<RegisteredServiceProvider<T>> getRegistrations(@NotNull Class<T> service) {
@@ -289,6 +297,7 @@ public class SimpleServicesManager implements ServicesManager {
*
* @return a copy of the set of known services
*/
@Override
@NotNull
public Set<Class<?>> getKnownServices() {
synchronized (providers) {
@@ -303,6 +312,7 @@ public class SimpleServicesManager implements ServicesManager {
* @param service service to check
* @return true if and only if there are registered providers
*/
@Override
public <T> boolean isProvidedFor(@NotNull Class<T> service) {
synchronized (providers) {
return providers.containsKey(service);

7
paper-api/src/main/java/org/bukkit/plugin/java/JavaPluginLoader.java
View File

@@ -64,6 +64,7 @@ public final class JavaPluginLoader implements PluginLoader {
server = instance;
}
@Override
@NotNull
public Plugin loadPlugin(@NotNull final File file) throws InvalidPluginException {
Validate.notNull(file, "File cannot be null");
@@ -141,6 +142,7 @@ public final class JavaPluginLoader implements PluginLoader {
return loader.plugin;
}
@Override
@NotNull
public PluginDescriptionFile getPluginDescription(@NotNull File file) throws InvalidDescriptionException {
Validate.notNull(file, "File cannot be null");
@@ -180,6 +182,7 @@ public final class JavaPluginLoader implements PluginLoader {
}
}
@Override
@NotNull
public Pattern[] getPluginFileFilters() {
return fileFilters.clone();
@@ -229,6 +232,7 @@ public final class JavaPluginLoader implements PluginLoader {
}
}
@Override
@NotNull
public Map<Class<? extends Event>, Set<RegisteredListener>> createRegisteredListeners(@NotNull Listener listener, @NotNull final Plugin plugin) {
Validate.notNull(plugin, "Plugin can not be null");
@@ -297,6 +301,7 @@ public final class JavaPluginLoader implements PluginLoader {
}
EventExecutor executor = new EventExecutor() {
@Override
public void execute(@NotNull Listener listener, @NotNull Event event) throws EventException {
try {
if (!eventClass.isAssignableFrom(event.getClass())) {
@@ -319,6 +324,7 @@ public final class JavaPluginLoader implements PluginLoader {
return ret;
}
@Override
public void enablePlugin(@NotNull final Plugin plugin) {
Validate.isTrue(plugin instanceof JavaPlugin, "Plugin is not associated with this PluginLoader");
@@ -346,6 +352,7 @@ public final class JavaPluginLoader implements PluginLoader {
}
}
@Override
public void disablePlugin(@NotNull Plugin plugin) {
Validate.isTrue(plugin instanceof JavaPlugin, "Plugin is not associated with this PluginLoader");

19
paper-api/src/main/java/org/bukkit/plugin/messaging/StandardMessenger.java
View File

@@ -168,12 +168,14 @@ public class StandardMessenger implements Messenger {
}
}
@Override
public boolean isReservedChannel(@NotNull String channel) {
channel = validateAndCorrectChannel(channel);
return channel.contains("minecraft") && !channel.equals("minecraft:brand");
}
@Override
public void registerOutgoingPluginChannel(@NotNull Plugin plugin, @NotNull String channel) {
if (plugin == null) {
throw new IllegalArgumentException("Plugin cannot be null");
@@ -186,6 +188,7 @@ public class StandardMessenger implements Messenger {
addToOutgoing(plugin, channel);
}
@Override
public void unregisterOutgoingPluginChannel(@NotNull Plugin plugin, @NotNull String channel) {
if (plugin == null) {
throw new IllegalArgumentException("Plugin cannot be null");
@@ -195,6 +198,7 @@ public class StandardMessenger implements Messenger {
removeFromOutgoing(plugin, channel);
}
@Override
public void unregisterOutgoingPluginChannel(@NotNull Plugin plugin) {
if (plugin == null) {
throw new IllegalArgumentException("Plugin cannot be null");
@@ -203,6 +207,7 @@ public class StandardMessenger implements Messenger {
removeFromOutgoing(plugin);
}
@Override
@NotNull
public PluginMessageListenerRegistration registerIncomingPluginChannel(@NotNull Plugin plugin, @NotNull String channel, @NotNull PluginMessageListener listener) {
if (plugin == null) {
@@ -223,6 +228,7 @@ public class StandardMessenger implements Messenger {
return result;
}
@Override
public void unregisterIncomingPluginChannel(@NotNull Plugin plugin, @NotNull String channel, @NotNull PluginMessageListener listener) {
if (plugin == null) {
throw new IllegalArgumentException("Plugin cannot be null");
@@ -235,6 +241,7 @@ public class StandardMessenger implements Messenger {
removeFromIncoming(new PluginMessageListenerRegistration(this, plugin, channel, listener));
}
@Override
public void unregisterIncomingPluginChannel(@NotNull Plugin plugin, @NotNull String channel) {
if (plugin == null) {
throw new IllegalArgumentException("Plugin cannot be null");
@@ -244,6 +251,7 @@ public class StandardMessenger implements Messenger {
removeFromIncoming(plugin, channel);
}
@Override
public void unregisterIncomingPluginChannel(@NotNull Plugin plugin) {
if (plugin == null) {
throw new IllegalArgumentException("Plugin cannot be null");
@@ -252,6 +260,7 @@ public class StandardMessenger implements Messenger {
removeFromIncoming(plugin);
}
@Override
@NotNull
public Set<String> getOutgoingChannels() {
synchronized (outgoingLock) {
@@ -260,6 +269,7 @@ public class StandardMessenger implements Messenger {
}
}
@Override
@NotNull
public Set<String> getOutgoingChannels(@NotNull Plugin plugin) {
if (plugin == null) {
@@ -277,6 +287,7 @@ public class StandardMessenger implements Messenger {
}
}
@Override
@NotNull
public Set<String> getIncomingChannels() {
synchronized (incomingLock) {
@@ -285,6 +296,7 @@ public class StandardMessenger implements Messenger {
}
}
@Override
@NotNull
public Set<String> getIncomingChannels(@NotNull Plugin plugin) {
if (plugin == null) {
@@ -308,6 +320,7 @@ public class StandardMessenger implements Messenger {
}
}
@Override
@NotNull
public Set<PluginMessageListenerRegistration> getIncomingChannelRegistrations(@NotNull Plugin plugin) {
if (plugin == null) {
@@ -325,6 +338,7 @@ public class StandardMessenger implements Messenger {
}
}
@Override
@NotNull
public Set<PluginMessageListenerRegistration> getIncomingChannelRegistrations(@NotNull String channel) {
channel = validateAndCorrectChannel(channel);
@@ -340,6 +354,7 @@ public class StandardMessenger implements Messenger {
}
}
@Override
@NotNull
public Set<PluginMessageListenerRegistration> getIncomingChannelRegistrations(@NotNull Plugin plugin, @NotNull String channel) {
if (plugin == null) {
@@ -366,6 +381,7 @@ public class StandardMessenger implements Messenger {
}
}
@Override
public boolean isRegistrationValid(@NotNull PluginMessageListenerRegistration registration) {
if (registration == null) {
throw new IllegalArgumentException("Registration cannot be null");
@@ -382,6 +398,7 @@ public class StandardMessenger implements Messenger {
}
}
@Override
public boolean isIncomingChannelRegistered(@NotNull Plugin plugin, @NotNull String channel) {
if (plugin == null) {
throw new IllegalArgumentException("Plugin cannot be null");
@@ -403,6 +420,7 @@ public class StandardMessenger implements Messenger {
}
}
@Override
public boolean isOutgoingChannelRegistered(@NotNull Plugin plugin, @NotNull String channel) {
if (plugin == null) {
throw new IllegalArgumentException("Plugin cannot be null");
@@ -420,6 +438,7 @@ public class StandardMessenger implements Messenger {
}
}
@Override
public void dispatchIncomingMessage(@NotNull Player source, @NotNull String channel, @NotNull byte[] message) {
if (source == null) {
throw new IllegalArgumentException("Player source cannot be null");