zhdev/oblak
1
0
Fork 0
Code Issues Pull requests Activity

chore(core): deprecate prefixed accessors/mutators in CommandManager (#377)

Browse source 
chore(core): deprecate prefixed accessors/mutators in CommandManager.java

All prefixed (actual) getters/setters in CommandManager have been deprecated, and non-prefixed alternatives have been introduced. I've also put some effort into improving the JavaDocs of these methods.
This commit is contained in:
Alexander Söderberg 2022-06-13 10:57:12 +02:00 • committed by Jason
parent 687cd4c536
commit 296539d56c
48 changed files with 400 additions and 157 deletions
Download patch file Download diff file Expand all files Collapse all files

4
cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/BukkitCommand.java
View file

@ -196,7 +196,7 @@ final class BukkitCommand<C> extends org.bukkit.command.Command implements Plugi
@Override
public @NonNull String getUsage() {
return this.manager.getCommandSyntaxFormatter().apply(
return this.manager.commandSyntaxFormatter().apply(
Collections.singletonList(Objects.requireNonNull(this.namedNode().getValue())),
this.namedNode()
);
@ -229,6 +229,6 @@ final class BukkitCommand<C> extends org.bukkit.command.Command implements Plugi
}
private CommandTree.@Nullable Node<CommandArgument<C, ?>> namedNode() {
return this.manager.getCommandTree().getNamedNode(this.command.getName());
return this.manager.commandTree().getNamedNode(this.command.getName());
}
}

38
cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/BukkitCommandManager.java
View file

@ -125,7 +125,7 @@ public class BukkitCommandManager<C> extends CommandManager<C> implements Brigad
)
throws Exception {
super(commandExecutionCoordinator, new BukkitPluginRegistrationHandler<>());
((BukkitPluginRegistrationHandler<C>) this.getCommandRegistrationHandler()).initialize(this);
((BukkitPluginRegistrationHandler<C>) this.commandRegistrationHandler()).initialize(this);
this.owningPlugin = owningPlugin;
this.commandSenderMapper = commandSenderMapper;
this.backwardsCommandSenderMapper = backwardsCommandSenderMapper;
@ -141,39 +141,39 @@ public class BukkitCommandManager<C> extends CommandManager<C> implements Brigad
this.registerCommandPreProcessor(new BukkitCommandPreprocessor<>(this));
/* Register Bukkit Parsers */
this.getParserRegistry().registerParserSupplier(TypeToken.get(World.class), parserParameters ->
this.parserRegistry().registerParserSupplier(TypeToken.get(World.class), parserParameters ->
new WorldArgument.WorldParser<>());
this.getParserRegistry().registerParserSupplier(TypeToken.get(Material.class), parserParameters ->
this.parserRegistry().registerParserSupplier(TypeToken.get(Material.class), parserParameters ->
new MaterialArgument.MaterialParser<>());
this.getParserRegistry().registerParserSupplier(TypeToken.get(Player.class), parserParameters ->
this.parserRegistry().registerParserSupplier(TypeToken.get(Player.class), parserParameters ->
new PlayerArgument.PlayerParser<>());
this.getParserRegistry().registerParserSupplier(TypeToken.get(OfflinePlayer.class), parserParameters ->
this.parserRegistry().registerParserSupplier(TypeToken.get(OfflinePlayer.class), parserParameters ->
new OfflinePlayerArgument.OfflinePlayerParser<>());
this.getParserRegistry().registerParserSupplier(TypeToken.get(Enchantment.class), parserParameters ->
this.parserRegistry().registerParserSupplier(TypeToken.get(Enchantment.class), parserParameters ->
new EnchantmentArgument.EnchantmentParser<>());
this.getParserRegistry().registerParserSupplier(TypeToken.get(Location.class), parserParameters ->
this.parserRegistry().registerParserSupplier(TypeToken.get(Location.class), parserParameters ->
new LocationArgument.LocationParser<>());
this.getParserRegistry().registerParserSupplier(TypeToken.get(Location2D.class), parserParameters ->
this.parserRegistry().registerParserSupplier(TypeToken.get(Location2D.class), parserParameters ->
new Location2DArgument.Location2DParser<>());
this.getParserRegistry().registerParserSupplier(TypeToken.get(ProtoItemStack.class), parserParameters ->
this.parserRegistry().registerParserSupplier(TypeToken.get(ProtoItemStack.class), parserParameters ->
new ItemStackArgument.Parser<>());
/* Register Entity Selector Parsers */
this.getParserRegistry().registerParserSupplier(TypeToken.get(SingleEntitySelector.class), parserParameters ->
this.parserRegistry().registerParserSupplier(TypeToken.get(SingleEntitySelector.class), parserParameters ->
new SingleEntitySelectorArgument.SingleEntitySelectorParser<>());
this.getParserRegistry().registerParserSupplier(TypeToken.get(SinglePlayerSelector.class), parserParameters ->
this.parserRegistry().registerParserSupplier(TypeToken.get(SinglePlayerSelector.class), parserParameters ->
new SinglePlayerSelectorArgument.SinglePlayerSelectorParser<>());
this.getParserRegistry().registerParserSupplier(TypeToken.get(MultipleEntitySelector.class), parserParameters ->
this.parserRegistry().registerParserSupplier(TypeToken.get(MultipleEntitySelector.class), parserParameters ->
new MultipleEntitySelectorArgument.MultipleEntitySelectorParser<>());
this.getParserRegistry().registerParserSupplier(TypeToken.get(MultiplePlayerSelector.class), parserParameters ->
this.parserRegistry().registerParserSupplier(TypeToken.get(MultiplePlayerSelector.class), parserParameters ->
new MultiplePlayerSelectorArgument.MultiplePlayerSelectorParser<>());
if (CraftBukkitReflection.classExists("org.bukkit.NamespacedKey")) {
this.registerParserSupplierFor(NamespacedKeyArgument.class);
this.getParserRegistry().registerAnnotationMapper(
this.parserRegistry().registerAnnotationMapper(
RequireExplicitNamespace.class,
(annotation, type) -> ParserParameters.single(BukkitParserParameters.REQUIRE_EXPLICIT_NAMESPACE, true)
);
this.getParserRegistry().registerAnnotationMapper(
this.parserRegistry().registerAnnotationMapper(
DefaultNamespace.class,
(annotation, type) -> ParserParameters.single(BukkitParserParameters.DEFAULT_NAMESPACE, annotation.value())
);
@ -191,7 +191,7 @@ public class BukkitCommandManager<C> extends CommandManager<C> implements Brigad
this.owningPlugin
);
this.setCaptionRegistry(new BukkitCaptionRegistryFactory<C>().create());
this.captionRegistry(new BukkitCaptionRegistryFactory<C>().create());
}
/**
@ -323,7 +323,7 @@ public class BukkitCommandManager<C> extends CommandManager<C> implements Brigad
try {
final CloudCommodoreManager<C> cloudCommodoreManager = new CloudCommodoreManager<>(this);
cloudCommodoreManager.initialize(this);
this.setCommandRegistrationHandler(cloudCommodoreManager);
this.commandRegistrationHandler(cloudCommodoreManager);
this.setSplitAliases(true);
} catch (final Throwable e) {
throw new BrigadierFailureException(BrigadierFailureReason.COMMODORE_NOT_PRESENT, e);
@ -337,8 +337,8 @@ public class BukkitCommandManager<C> extends CommandManager<C> implements Brigad
*/
@Override
public @Nullable CloudBrigadierManager<C, ?> brigadierManager() {
if (this.getCommandRegistrationHandler() instanceof CloudCommodoreManager) {
return ((CloudCommodoreManager<C>) this.getCommandRegistrationHandler()).brigadierManager();
if (this.commandRegistrationHandler() instanceof CloudCommodoreManager) {
return ((CloudCommodoreManager<C>) this.commandRegistrationHandler()).brigadierManager();
}
return null;
}

2
cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/BukkitPluginRegistrationHandler.java
View file

@ -75,7 +75,7 @@ public class BukkitPluginRegistrationHandler<C> implements CommandRegistrationHa
public final boolean registerCommand(final @NonNull Command<?> command) {
/* We only care about the root command argument */
final CommandArgument<?, ?> commandArgument = command.getArguments().get(0);
if (!(this.bukkitCommandManager.getCommandRegistrationHandler() instanceof CloudCommodoreManager)
if (!(this.bukkitCommandManager.commandRegistrationHandler() instanceof CloudCommodoreManager)
&& this.registeredCommands.containsKey(commandArgument)) {
return false;
}

2
cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/CloudCommodoreManager.java
View file

@ -97,7 +97,7 @@ class CloudCommodoreManager<C> extends BukkitPluginRegistrationHandler<C> {
final LiteralCommandNode<?> literalCommandNode = this.brigadierManager
.createLiteralCommandNode(label, command, (commandSourceStack, commandPermission) -> {
// We need to check that the command still exists...
if (this.commandManager.getCommandTree().getNamedNode(label) == null) {
if (this.commandManager.commandTree().getNamedNode(label) == null) {
return false;
}

2
cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/argument/NamespacedKeyArgument.java
View file

@ -356,7 +356,7 @@ public final class NamespacedKeyArgument<C> extends CommandArgument<C, Namespace
*/
@SuppressWarnings("unused")
private static <C> void registerParserSupplier(final @NonNull BukkitCommandManager<C> commandManager) {
commandManager.getParserRegistry()
commandManager.parserRegistry()
.registerParserSupplier(TypeToken.get(NamespacedKey.class), params -> new Parser<>(
params.has(BukkitParserParameters.REQUIRE_EXPLICIT_NAMESPACE),
params.get(BukkitParserParameters.DEFAULT_NAMESPACE, NamespacedKey.MINECRAFT)

2
cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/BlockPredicateArgument.java
View file

@ -335,7 +335,7 @@ public final class BlockPredicateArgument<C> extends CommandArgument<C, BlockPre
*/
@SuppressWarnings("unused")
private static <C> void registerParserSupplier(final @NonNull BukkitCommandManager<C> commandManager) {
commandManager.getParserRegistry()
commandManager.parserRegistry()
.registerParserSupplier(TypeToken.get(BlockPredicate.class), params -> new BlockPredicateArgument.Parser<>());
}
}

2
cloud-minecraft/cloud-bukkit/src/main/java/cloud/commandframework/bukkit/parsers/ItemStackPredicateArgument.java
View file

@ -271,7 +271,7 @@ public final class ItemStackPredicateArgument<C> extends CommandArgument<C, Item
*/
@SuppressWarnings("unused")
private static <C> void registerParserSupplier(final @NonNull BukkitCommandManager<C> commandManager) {
commandManager.getParserRegistry().registerParserSupplier(
commandManager.parserRegistry().registerParserSupplier(
TypeToken.get(ItemStackPredicate.class),
params -> new ItemStackPredicateArgument.Parser<>()
);