From 65bb4d7a5dba5174d617edf82c49ba787d4aab96 Mon Sep 17 00:00:00 2001 From: jmp Date: Fri, 12 Mar 2021 13:28:51 -0800 Subject: [PATCH] fabric: javadoc cleanup --- .../parser/MappedArgumentParser.java | 8 ++ .../brigadier/BrigadierMappingBuilder.java | 1 + .../argument/StringReaderAsQueue.java | 2 + .../argument/WrappedBrigadierParser.java | 1 + .../fabric/FabricCaptionKeys.java | 23 +++++- .../fabric/FabricCaptionRegistry.java | 31 ++++++-- .../fabric/FabricClientCommandManager.java | 3 + .../fabric/FabricCommandContextKeys.java | 7 ++ .../fabric/FabricCommandManager.java | 57 ++++++++------ .../fabric/FabricServerCommandManager.java | 5 ++ .../fabric/argument/AngleArgument.java | 25 +++++-- .../fabric/argument/AxisArgument.java | 27 +++++-- .../fabric/argument/ColorArgument.java | 28 +++++-- .../fabric/argument/CompoundTagArgument.java | 40 +++++++--- .../fabric/argument/EntityAnchorArgument.java | 30 ++++++-- .../argument/FabricArgumentParsers.java | 8 +- .../fabric/argument/FloatRangeArgument.java | 32 ++++++-- .../fabric/argument/IdentifierArgument.java | 30 ++++++-- .../fabric/argument/IntRangeArgument.java | 30 ++++++-- .../fabric/argument/ItemDataArgument.java | 33 ++++++--- .../fabric/argument/NbtPathArgument.java | 36 ++++++--- .../fabric/argument/NbtTagArgument.java | 29 +++++--- .../argument/ParticleEffectArgument.java | 36 ++++++--- .../argument/RegistryEntryArgument.java | 74 ++++++++++++------- .../argument/ScoreboardCriterionArgument.java | 25 +++++-- .../argument/ScoreboardOperationArgument.java | 16 +++- .../fabric/argument/SidedArgumentParser.java | 11 ++- .../fabric/argument/StatusEffectArgument.java | 25 +++++-- .../fabric/argument/TeamArgument.java | 51 ++++++++++--- .../fabric/argument/TimeArgument.java | 19 ++++- .../fabric/argument/package-info.java | 2 + .../argument/server/MessageArgument.java | 15 +++- .../MultipleEntitySelectorArgument.java | 12 ++- .../MultiplePlayerSelectorArgument.java | 14 +++- .../server/SingleEntitySelectorArgument.java | 14 +++- .../server/SinglePlayerSelectorArgument.java | 14 +++- .../commandframework/fabric/data/Message.java | 4 + .../fabric/data/MinecraftTime.java | 12 ++- .../fabric/data/MultipleEntitySelector.java | 3 + .../fabric/data/MultiplePlayerSelector.java | 3 + .../fabric/data/Selector.java | 12 +++ .../fabric/data/SingleEntitySelector.java | 3 + .../fabric/data/SinglePlayerSelector.java | 3 + .../fabric/data/package-info.java | 2 + .../commandframework/fabric/package-info.java | 4 +- 45 files changed, 649 insertions(+), 211 deletions(-) diff --git a/cloud-core/src/main/java/cloud/commandframework/arguments/parser/MappedArgumentParser.java b/cloud-core/src/main/java/cloud/commandframework/arguments/parser/MappedArgumentParser.java index 23273ff8..8139b5fa 100644 --- a/cloud-core/src/main/java/cloud/commandframework/arguments/parser/MappedArgumentParser.java +++ b/cloud-core/src/main/java/cloud/commandframework/arguments/parser/MappedArgumentParser.java @@ -32,6 +32,14 @@ import java.util.List; import java.util.Queue; import java.util.function.BiFunction; +/** + * An argument parser which wraps another argument parser, converting the output type. + * + * @param sender type + * @param base output type + * @param mapped output type + * @since 1.5.0 + */ public final class MappedArgumentParser implements ArgumentParser { private final ArgumentParser base; private final BiFunction, I, ArgumentParseResult> mapper; diff --git a/cloud-minecraft/cloud-brigadier/src/main/java/cloud/commandframework/brigadier/BrigadierMappingBuilder.java b/cloud-minecraft/cloud-brigadier/src/main/java/cloud/commandframework/brigadier/BrigadierMappingBuilder.java index 26fca229..a54b885b 100644 --- a/cloud-minecraft/cloud-brigadier/src/main/java/cloud/commandframework/brigadier/BrigadierMappingBuilder.java +++ b/cloud-minecraft/cloud-brigadier/src/main/java/cloud/commandframework/brigadier/BrigadierMappingBuilder.java @@ -39,6 +39,7 @@ import static java.util.Objects.requireNonNull; * * @param the Cloud argument parser type * @param the brigadier-native sender type + * @since 1.5.0 */ public interface BrigadierMappingBuilder, S> { diff --git a/cloud-minecraft/cloud-brigadier/src/main/java/cloud/commandframework/brigadier/argument/StringReaderAsQueue.java b/cloud-minecraft/cloud-brigadier/src/main/java/cloud/commandframework/brigadier/argument/StringReaderAsQueue.java index ab6ab767..96f2f40e 100644 --- a/cloud-minecraft/cloud-brigadier/src/main/java/cloud/commandframework/brigadier/argument/StringReaderAsQueue.java +++ b/cloud-minecraft/cloud-brigadier/src/main/java/cloud/commandframework/brigadier/argument/StringReaderAsQueue.java @@ -39,6 +39,8 @@ import java.util.Queue; * *

This can be implemented either by wrapping an existing {@link StringReader} instance, or extending {@link StringReader} * at its creation time to implement this interface.

+ * + * @since 1.5.0 */ public interface StringReaderAsQueue extends Queue { diff --git a/cloud-minecraft/cloud-brigadier/src/main/java/cloud/commandframework/brigadier/argument/WrappedBrigadierParser.java b/cloud-minecraft/cloud-brigadier/src/main/java/cloud/commandframework/brigadier/argument/WrappedBrigadierParser.java index 54f9cdb5..cbb8b08a 100644 --- a/cloud-minecraft/cloud-brigadier/src/main/java/cloud/commandframework/brigadier/argument/WrappedBrigadierParser.java +++ b/cloud-minecraft/cloud-brigadier/src/main/java/cloud/commandframework/brigadier/argument/WrappedBrigadierParser.java @@ -49,6 +49,7 @@ import static java.util.Objects.requireNonNull; * * @param the sender type * @param the value type of the argument + * @since 1.5.0 */ public final class WrappedBrigadierParser implements ArgumentParser { public static final String COMMAND_CONTEXT_BRIGADIER_NATIVE_SENDER = "_cloud_brigadier_native_sender"; diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricCaptionKeys.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricCaptionKeys.java index ce3f0445..9839e08d 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricCaptionKeys.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricCaptionKeys.java @@ -31,21 +31,35 @@ import java.util.Collection; import java.util.Collections; import java.util.HashSet; +/** + * {@link Caption} instances for messages in cloud-fabric + * + * @since 1.5.0 + */ public final class FabricCaptionKeys { - private FabricCaptionKeys() { - } - private static final Collection RECOGNIZED_CAPTIONS = new HashSet<>(); + /** + * Variables: {id}, {registry} + * + * @since 1.5.0 + */ public static final Caption ARGUMENT_PARSE_FAILURE_REGISTRY_ENTRY_UNKNOWN_ENTRY = of( "argument.parse.failure.registry_entry.unknown_entry" ); - + /** + * Variables: {input} + * + * @since 1.5.0 + */ public static final Caption ARGUMENT_PARSE_FAILURE_TEAM_UNKNOWN = of( "argument.parse.failure.team.unknown" ); + private FabricCaptionKeys() { + } + private static @NonNull Caption of(final @NonNull String key) { final Caption caption = Caption.of(key); RECOGNIZED_CAPTIONS.add(caption); @@ -56,6 +70,7 @@ public final class FabricCaptionKeys { * Get an immutable collection containing all standard caption keys * * @return Immutable collection of keys + * @since 1.5.0 */ public static @NonNull Collection<@NonNull Caption> getFabricCaptionKeys() { return Collections.unmodifiableCollection(RECOGNIZED_CAPTIONS); diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricCaptionRegistry.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricCaptionRegistry.java index b871fca8..0da8b6c6 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricCaptionRegistry.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricCaptionRegistry.java @@ -26,19 +26,38 @@ package cloud.commandframework.fabric; import cloud.commandframework.captions.SimpleCaptionRegistry; +/** + * Caption registry that uses bi-functions to produce messages + * + * @param Command sender type + * @since 1.5.0 + */ public class FabricCaptionRegistry extends SimpleCaptionRegistry { + /** + * Default caption for {@link FabricCaptionKeys#ARGUMENT_PARSE_FAILURE_REGISTRY_ENTRY_UNKNOWN_ENTRY} + * + * @since 1.5.0 + */ public static final String ARGUMENT_PARSE_FAILURE_REGISTRY_ENTRY_UNKNOWN_ENTRY = "Could not find key {id} in registry '{registry}'"; - - public static final String ARGUMENT_PARSE_FAILURE_TEAM_UNKOWN = "Could not find any team named '{input}'!"; + /** + * Default caption for {@link FabricCaptionKeys#ARGUMENT_PARSE_FAILURE_TEAM_UNKNOWN} + * + * @since 1.5.0 + */ + public static final String ARGUMENT_PARSE_FAILURE_TEAM_UNKNOWN = "Could not find any team named '{input}'!"; protected FabricCaptionRegistry() { super(); - this.registerMessageFactory(FabricCaptionKeys.ARGUMENT_PARSE_FAILURE_REGISTRY_ENTRY_UNKNOWN_ENTRY, - (caption, sender) -> ARGUMENT_PARSE_FAILURE_REGISTRY_ENTRY_UNKNOWN_ENTRY); - this.registerMessageFactory(FabricCaptionKeys.ARGUMENT_PARSE_FAILURE_TEAM_UNKNOWN, - (caption, sender) -> ARGUMENT_PARSE_FAILURE_TEAM_UNKOWN); + this.registerMessageFactory( + FabricCaptionKeys.ARGUMENT_PARSE_FAILURE_REGISTRY_ENTRY_UNKNOWN_ENTRY, + (caption, sender) -> ARGUMENT_PARSE_FAILURE_REGISTRY_ENTRY_UNKNOWN_ENTRY + ); + this.registerMessageFactory( + FabricCaptionKeys.ARGUMENT_PARSE_FAILURE_TEAM_UNKNOWN, + (caption, sender) -> ARGUMENT_PARSE_FAILURE_TEAM_UNKNOWN + ); } diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricClientCommandManager.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricClientCommandManager.java index 31594c1b..dca9fe3b 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricClientCommandManager.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricClientCommandManager.java @@ -53,6 +53,7 @@ public final class FabricClientCommandManager extends FabricCommandManager createNative( final Function, CommandExecutionCoordinator> execCoordinator @@ -73,6 +74,7 @@ public final class FabricClientCommandManager extends FabricCommandManager extends FabricCommandManager NATIVE_COMMAND_SOURCE = SimpleCloudKey.of( "cloud:fabric_command_source", TypeToken.get(CommandSource.class) diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricCommandManager.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricCommandManager.java index e5f9a439..f264ca50 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricCommandManager.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricCommandManager.java @@ -108,7 +108,9 @@ import java.util.function.Supplier; * @see FabricServerCommandManager for server commands * @since 1.5.0 */ -public abstract class FabricCommandManager extends CommandManager implements BrigadierManagerHolder { +public abstract class FabricCommandManager extends CommandManager implements + BrigadierManagerHolder { + private static final Logger LOGGER = LogManager.getLogger(); private static final int MOD_PUBLIC_STATIC_FINAL = Modifier.PUBLIC | Modifier.STATIC | Modifier.FINAL; @@ -120,18 +122,19 @@ public abstract class FabricCommandManager extends C /** * Create a new command manager instance. * - * @param commandExecutionCoordinator Execution coordinator instance. The coordinator is in charge of executing incoming - * commands. Some considerations must be made when picking a suitable execution coordinator - * for your platform. For example, an entirely asynchronous coordinator is not suitable - * when the parsers used in that particular platform are not thread safe. If you have - * commands that perform blocking operations, however, it might not be a good idea to - * use a synchronous execution coordinator. In most cases you will want to pick between - * {@link CommandExecutionCoordinator#simpleCoordinator()} and - * {@link AsynchronousCommandExecutionCoordinator} + * @param commandExecutionCoordinator Execution coordinator instance. The coordinator is in charge of executing incoming + * commands. Some considerations must be made when picking a suitable execution coordinator + * for your platform. For example, an entirely asynchronous coordinator is not suitable + * when the parsers used in that particular platform are not thread safe. If you have + * commands that perform blocking operations, however, it might not be a good idea to + * use a synchronous execution coordinator. In most cases you will want to pick between + * {@link CommandExecutionCoordinator#simpleCoordinator()} and + * {@link AsynchronousCommandExecutionCoordinator} * @param commandSourceMapper Function that maps {@link CommandSource} to the command sender type * @param backwardsCommandSourceMapper Function that maps the command sender type to {@link CommandSource} - * @param registrationHandler the handler accepting command registrations - * @param dummyCommandSourceProvider a provider of a dummy command source, for use with brigadier registration + * @param registrationHandler the handler accepting command registrations + * @param dummyCommandSourceProvider a provider of a dummy command source, for use with brigadier registration + * @since 1.5.0 */ @SuppressWarnings("unchecked") FabricCommandManager( @@ -140,7 +143,7 @@ public abstract class FabricCommandManager extends C final Function backwardsCommandSourceMapper, final FabricCommandRegistrationHandler registrationHandler, final Supplier dummyCommandSourceProvider - ) { + ) { super(commandExecutionCoordinator, registrationHandler); this.commandSourceMapper = commandSourceMapper; this.backwardsCommandSourceMapper = backwardsCommandSourceMapper; @@ -151,7 +154,7 @@ public abstract class FabricCommandManager extends C // See net.minecraft.server.function.FunctionLoader.reload for reference this.commandSourceMapper.apply(dummyCommandSourceProvider.get()), this - )); + )); this.brigadierManager.backwardsBrigadierSenderMapper(this.backwardsCommandSourceMapper); this.brigadierManager.brigadierSenderMapper(this.commandSourceMapper); this.registerNativeBrigadierMappings(this.brigadierManager); @@ -186,8 +189,10 @@ public abstract class FabricCommandManager extends C this.registerConstantNativeParserSupplier(ItemStackArgument.class, ItemStackArgumentType.itemStack()); /* Wrapped/Constant Brigadier types, mapped value type */ - this.registerConstantNativeParserSupplier(BlockPredicateArgumentType.BlockPredicate.class, - BlockPredicateArgumentType.blockPredicate()); + this.registerConstantNativeParserSupplier( + BlockPredicateArgumentType.BlockPredicate.class, + BlockPredicateArgumentType.blockPredicate() + ); this.registerConstantNativeParserSupplier(MessageArgumentType.MessageFormat.class, MessageArgumentType.message()); /*this.registerConstantNativeParserSupplier(GameProfile.class, GameProfileArgumentType.gameProfile()); this.registerConstantNativeParserSupplier(BlockPos.class, BlockPosArgumentType.blockPos()); @@ -210,7 +215,9 @@ public abstract class FabricCommandManager extends C @SuppressWarnings({"unchecked", "rawtypes"}) private void registerRegistryEntryMappings() { - this.brigadierManager.registerMapping(new TypeToken>() {}, + this.brigadierManager.registerMapping( + new TypeToken>() { + }, builder -> builder.to(argument -> { /* several registries have specialized argument types, so let's use those where possible */ final RegistryKey> registry = argument.getRegistry(); @@ -288,17 +295,20 @@ public abstract class FabricCommandManager extends C seenClasses.add(GenericTypeReflector.erase(valueType)); /* and now, finally, we can register */ - this.getParserRegistry().registerParserSupplier(TypeToken.get(valueType), - params -> new RegistryEntryArgument.RegistryEntryParser(key)); + this.getParserRegistry().registerParserSupplier( + TypeToken.get(valueType), + params -> new RegistryEntryArgument.RegistryEntryParser(key) + ); } } /** * Register a parser supplier for a brigadier type that has no options and whose output can be directly used. * - * @param type the Java type to map + * @param type the Java type to map * @param argument the Brigadier parser - * @param value type + * @param value type + * @since 1.5.0 */ final void registerConstantNativeParserSupplier(final Class type, final ArgumentType argument) { this.registerConstantNativeParserSupplier(TypeToken.get(type), argument); @@ -307,9 +317,10 @@ public abstract class FabricCommandManager extends C /** * Register a parser supplier for a brigadier type that has no options and whose output can be directly used. * - * @param type the Java type to map + * @param type the Java type to map * @param argument the Brigadier parser - * @param value type + * @param value type + * @since 1.5.0 */ final void registerConstantNativeParserSupplier(final TypeToken type, final ArgumentType argument) { this.getParserRegistry().registerParserSupplier(type, params -> new WrappedBrigadierParser<>(argument)); @@ -324,6 +335,7 @@ public abstract class FabricCommandManager extends C * Gets the mapper from a game {@link CommandSource} to the manager's {@code C} type. * * @return Command source mapper + * @since 1.5.0 */ public final @NonNull Function<@NonNull S, @NonNull C> getCommandSourceMapper() { return this.commandSourceMapper; @@ -333,6 +345,7 @@ public abstract class FabricCommandManager extends C * Gets the mapper from the manager's {@code C} type to a game {@link CommandSource}. * * @return Command source mapper + * @since 1.5.0 */ public final @NonNull Function<@NonNull C, @NonNull S> getBackwardsCommandSourceMapper() { return this.backwardsCommandSourceMapper; diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricServerCommandManager.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricServerCommandManager.java index 1382d5ef..faf458e5 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricServerCommandManager.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/FabricServerCommandManager.java @@ -63,6 +63,8 @@ public final class FabricServerCommandManager extends FabricCommandManagerThe default value is {@link CommandManager.RegistrationEnvironment#ALL}.

+ * + * @since 1.5.0 */ public static final CommandMeta.Key META_REGISTRATION_ENVIRONMENT = CommandMeta.Key.of( CommandManager.RegistrationEnvironment.class, @@ -75,6 +77,7 @@ public final class FabricServerCommandManager extends FabricCommandManager createNative( final Function, CommandExecutionCoordinator> execCoordinator @@ -95,6 +98,7 @@ public final class FabricServerCommandManager extends FabricCommandManager, @NonNull CommandExecutionCoordinator> commandExecutionCoordinator, @@ -152,6 +156,7 @@ public final class FabricServerCommandManager extends FabricCommandManager extends CommandArgument Command sender type * @return Created builder + * @since 1.5.0 */ public static AngleArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new AngleArgument.Builder<>(name); @@ -78,29 +79,32 @@ public final class AngleArgument extends CommandArgument Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull AngleArgument of(final @NonNull String name) { return AngleArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type - * @return Created argument + * @return Created argument + * @since 1.5.0 */ public static @NonNull AngleArgument optional(final @NonNull String name) { return AngleArgument.newBuilder(name).asOptional().build(); } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * - * @param name Argument name - * @param defaultAngle Default angle, in degrees - * @param Command sender type + * @param name Argument name + * @param defaultAngle Default angle, in degrees + * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull AngleArgument optional( final @NonNull String name, @@ -110,6 +114,12 @@ public final class AngleArgument extends CommandArgument sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -117,9 +127,10 @@ public final class AngleArgument extends CommandArgument build() { diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/AxisArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/AxisArgument.java index 42c1c6e1..5d5a751c 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/AxisArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/AxisArgument.java @@ -45,7 +45,9 @@ import java.util.function.BiFunction; * @since 1.5.0 */ public final class AxisArgument extends CommandArgument> { - private static final TypeToken> TYPE = new TypeToken>() {}; + + private static final TypeToken> TYPE = new TypeToken>() { + }; AxisArgument( final boolean required, @@ -69,6 +71,7 @@ public final class AxisArgument extends CommandArgument Command sender type * @return Created builder + * @since 1.5.0 */ public static AxisArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new AxisArgument.Builder<>(name); @@ -80,29 +83,32 @@ public final class AxisArgument extends CommandArgument Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull AxisArgument of(final @NonNull String name) { return AxisArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type - * @return Created argument + * @return Created argument + * @since 1.5.0 */ public static @NonNull AxisArgument optional(final @NonNull String name) { return AxisArgument.newBuilder(name).asOptional().build(); } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * - * @param name Argument name + * @param name Argument name * @param defaultValues Default axes to include - * @param Command sender type + * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull AxisArgument optional( final @NonNull String name, @@ -116,6 +122,12 @@ public final class AxisArgument extends CommandArgument sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder, Builder> { Builder(final @NonNull String name) { @@ -123,9 +135,10 @@ public final class AxisArgument extends CommandArgument build() { diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ColorArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ColorArgument.java index 39824434..f5695dec 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ColorArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ColorArgument.java @@ -50,49 +50,54 @@ public final class ColorArgument extends CommandArgument { final @Nullable BiFunction, String, List> suggestionsProvider ) { super(required, name, new WrappedBrigadierParser<>(ColorArgumentType.color()), defaultValue, Formatting.class, - suggestionsProvider); + suggestionsProvider + ); } /** - * Create a new builder + * Create a new builder. * * @param name Name of the component * @param Command sender type * @return Created builder + * @since 1.5.0 */ public static ColorArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new ColorArgument.Builder<>(name); } /** - * Create a new required command component + * Create a new required command argument. * * @param name Component name * @param Command sender type * @return Created component + * @since 1.5.0 */ public static @NonNull ColorArgument of(final @NonNull String name) { return ColorArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command component + * Create a new optional command argument. * * @param name Component name * @param Command sender type * @return Created component + * @since 1.5.0 */ public static @NonNull ColorArgument optional(final @NonNull String name) { return ColorArgument.newBuilder(name).asOptional().build(); } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * - * @param name Component name + * @param name Component name * @param defaultColor Default colour, must be {@link Formatting#isColor() a color} - * @param Command sender type + * @param Command sender type * @return Created component + * @since 1.5.0 */ public static @NonNull ColorArgument optional( final @NonNull String name, @@ -105,6 +110,12 @@ public final class ColorArgument extends CommandArgument { } + /** + * Builder for {@link ColorArgument}. + * + * @param sender type + * @since 1.5.0 + */ public static final class Builder extends CommandArgument.TypedBuilder> { Builder(final @NonNull String name) { @@ -112,9 +123,10 @@ public final class ColorArgument extends CommandArgument { } /** - * Build a new argument + * Build a new color argument. * * @return Constructed argument + * @since 1.5.0 */ @Override public @NonNull ColorArgument build() { diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/CompoundTagArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/CompoundTagArgument.java index 8412cb8d..0f497642 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/CompoundTagArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/CompoundTagArgument.java @@ -60,45 +60,49 @@ public final class CompoundTagArgument extends CommandArgument Command sender type * @return Created builder + * @since 1.5.0 */ public static CompoundTagArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new CompoundTagArgument.Builder<>(name); } /** - * Create a new required command argument + * Create a new required command argument. * * @param name Component name * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull CompoundTagArgument of(final @NonNull String name) { return CompoundTagArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type - * @return Created argument + * @return Created argument + * @since 1.5.0 */ public static @NonNull CompoundTagArgument optional(final @NonNull String name) { return CompoundTagArgument.newBuilder(name).asOptional().build(); } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * - * @param name Component name - * @param defaultTag Default tag value - * @param Command sender type - * @return Created component + * @param name Component name + * @param defaultTag Default tag value + * @param Command sender type + * @return Created argument + * @since 1.5.0 */ public static @NonNull CompoundTagArgument optional( final @NonNull String name, @@ -108,6 +112,12 @@ public final class CompoundTagArgument extends CommandArgument sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -115,13 +125,19 @@ public final class CompoundTagArgument extends CommandArgument build() { - return new CompoundTagArgument<>(this.isRequired(), this.getName(), this.getDefaultValue(), this.getSuggestionsProvider()); + return new CompoundTagArgument<>( + this.isRequired(), + this.getName(), + this.getDefaultValue(), + this.getSuggestionsProvider() + ); } } diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/EntityAnchorArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/EntityAnchorArgument.java index 1df70859..7cb47ad5 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/EntityAnchorArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/EntityAnchorArgument.java @@ -64,6 +64,7 @@ public final class EntityAnchorArgument extends CommandArgument Command sender type * @return Created builder + * @since 1.5.0 */ public static EntityAnchorArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new EntityAnchorArgument.Builder<>(name); @@ -75,29 +76,32 @@ public final class EntityAnchorArgument extends CommandArgument Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull EntityAnchorArgument of(final @NonNull String name) { return EntityAnchorArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type - * @return Created argument + * @return Created argument + * @since 1.5.0 */ public static @NonNull EntityAnchorArgument optional(final @NonNull String name) { return EntityAnchorArgument.newBuilder(name).asOptional().build(); } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * - * @param name Argument name + * @param name Argument name * @param defaultValue Default value - * @param Command sender type + * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull EntityAnchorArgument optional( final @NonNull String name, @@ -107,6 +111,12 @@ public final class EntityAnchorArgument extends CommandArgument sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -114,13 +124,19 @@ public final class EntityAnchorArgument extends CommandArgument build() { - return new EntityAnchorArgument<>(this.isRequired(), this.getName(), this.getDefaultValue(), this.getSuggestionsProvider()); + return new EntityAnchorArgument<>( + this.isRequired(), + this.getName(), + this.getDefaultValue(), + this.getSuggestionsProvider() + ); } } diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/FabricArgumentParsers.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/FabricArgumentParsers.java index bf65bd50..a54acbdf 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/FabricArgumentParsers.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/FabricArgumentParsers.java @@ -67,6 +67,7 @@ public final class FabricArgumentParsers { * * @param sender type * @return a parser instance + * @since 1.5.0 */ public static ArgumentParser time() { return new WrappedBrigadierParser(TimeArgumentType.time()) @@ -78,6 +79,7 @@ public final class FabricArgumentParsers { * * @param sender type * @return a parser instance + * @since 1.5.0 */ public static ArgumentParser singlePlayerSelector() { return new WrappedBrigadierParser(EntityArgumentType.player()) @@ -103,6 +105,7 @@ public final class FabricArgumentParsers { * * @param sender type * @return a parser instance + * @since 1.5.0 */ public static ArgumentParser multiplePlayerSelector() { return new WrappedBrigadierParser(EntityArgumentType.players()) @@ -128,6 +131,7 @@ public final class FabricArgumentParsers { * * @param sender type * @return a parser instance + * @since 1.5.0 */ public static ArgumentParser singleEntitySelector() { return new WrappedBrigadierParser(EntityArgumentType.entity()) @@ -153,6 +157,7 @@ public final class FabricArgumentParsers { * * @param sender type * @return a parser instance + * @since 1.5.0 */ public static ArgumentParser multipleEntitySelector() { return new WrappedBrigadierParser(EntityArgumentType.entities()) @@ -178,6 +183,7 @@ public final class FabricArgumentParsers { * * @param sender type * @return a parser instance + * @since 1.5.0 */ public static ArgumentParser message() { return new WrappedBrigadierParser(MessageArgumentType.message()) @@ -199,7 +205,7 @@ public final class FabricArgumentParsers { } private static @NonNull IllegalStateException serverOnly() { - return new IllegalStateException("This argument is server-only"); + return new IllegalStateException("This command argument type is server-only."); } static final class MessageImpl implements Message { diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/FloatRangeArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/FloatRangeArgument.java index 7bcc32f6..e4a2b1f1 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/FloatRangeArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/FloatRangeArgument.java @@ -66,6 +66,7 @@ public final class FloatRangeArgument extends CommandArgument Command sender type * @return Created builder + * @since 1.5.0 */ public static FloatRangeArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new FloatRangeArgument.Builder<>(name); @@ -77,33 +78,36 @@ public final class FloatRangeArgument extends CommandArgument Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull FloatRangeArgument of(final @NonNull String name) { return FloatRangeArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type - * @return Created argument + * @return Created argument + * @since 1.5.0 */ public static @NonNull FloatRangeArgument optional(final @NonNull String name) { return FloatRangeArgument.newBuilder(name).asOptional().build(); } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * - * @param name Argument name + * @param name Argument name * @param defaultValue Default value - * @param Command sender type + * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull FloatRangeArgument optional( final @NonNull String name, - final NumberRange.FloatRange defaultValue + final NumberRange.@NonNull FloatRange defaultValue ) { final StringBuilder value = new StringBuilder(6); if (defaultValue.getMin() != null) { @@ -118,6 +122,12 @@ public final class FloatRangeArgument extends CommandArgument sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -125,13 +135,19 @@ public final class FloatRangeArgument extends CommandArgument build() { - return new FloatRangeArgument<>(this.isRequired(), this.getName(), this.getDefaultValue(), this.getSuggestionsProvider()); + return new FloatRangeArgument<>( + this.isRequired(), + this.getName(), + this.getDefaultValue(), + this.getSuggestionsProvider() + ); } } diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/IdentifierArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/IdentifierArgument.java index 2c442691..c43a76cd 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/IdentifierArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/IdentifierArgument.java @@ -65,6 +65,7 @@ public final class IdentifierArgument extends CommandArgument * @param name Name of the argument * @param Command sender type * @return Created builder + * @since 1.5.0 */ public static IdentifierArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new IdentifierArgument.Builder<>(name); @@ -76,29 +77,32 @@ public final class IdentifierArgument extends CommandArgument * @param name Component name * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull IdentifierArgument of(final @NonNull String name) { return IdentifierArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type - * @return Created argument + * @return Created argument + * @since 1.5.0 */ public static @NonNull IdentifierArgument optional(final @NonNull String name) { return IdentifierArgument.newBuilder(name).asOptional().build(); } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * - * @param name Argument name + * @param name Argument name * @param defaultValue Default value - * @param Command sender type + * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull IdentifierArgument optional( final @NonNull String name, @@ -108,6 +112,12 @@ public final class IdentifierArgument extends CommandArgument } + /** + * Builder for {@link IdentifierArgument}. + * + * @param sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -115,13 +125,19 @@ public final class IdentifierArgument extends CommandArgument } /** - * Build a new criterion argument + * Build a new identifier argument. * * @return Constructed argument + * @since 1.5.0 */ @Override public @NonNull IdentifierArgument build() { - return new IdentifierArgument<>(this.isRequired(), this.getName(), this.getDefaultValue(), this.getSuggestionsProvider()); + return new IdentifierArgument<>( + this.isRequired(), + this.getName(), + this.getDefaultValue(), + this.getSuggestionsProvider() + ); } } diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/IntRangeArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/IntRangeArgument.java index 8a4675f3..555a5136 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/IntRangeArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/IntRangeArgument.java @@ -66,6 +66,7 @@ public final class IntRangeArgument extends CommandArgument Command sender type * @return Created builder + * @since 1.5.0 */ public static IntRangeArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new IntRangeArgument.Builder<>(name); @@ -77,29 +78,32 @@ public final class IntRangeArgument extends CommandArgument Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull IntRangeArgument of(final @NonNull String name) { return IntRangeArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type - * @return Created argument + * @return Created argument + * @since 1.5.0 */ public static @NonNull IntRangeArgument optional(final @NonNull String name) { return IntRangeArgument.newBuilder(name).asOptional().build(); } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * - * @param name Argument name + * @param name Argument name * @param defaultValue Default value - * @param Command sender type + * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull IntRangeArgument optional( final @NonNull String name, @@ -118,6 +122,12 @@ public final class IntRangeArgument extends CommandArgument sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -125,13 +135,19 @@ public final class IntRangeArgument extends CommandArgument build() { - return new IntRangeArgument<>(this.isRequired(), this.getName(), this.getDefaultValue(), this.getSuggestionsProvider()); + return new IntRangeArgument<>( + this.isRequired(), + this.getName(), + this.getDefaultValue(), + this.getSuggestionsProvider() + ); } } diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ItemDataArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ItemDataArgument.java index 07ccd735..57384946 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ItemDataArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ItemDataArgument.java @@ -38,7 +38,7 @@ import java.util.List; import java.util.function.BiFunction; /** - * An argument parsing an item identifier and optional NBT data + * An argument parsing an item identifier and optional NBT data. * * @param the sender type * @since 1.5.0 @@ -67,6 +67,7 @@ public final class ItemDataArgument extends CommandArgument Command sender type * @return Created builder + * @since 1.5.0 */ public static ItemDataArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new ItemDataArgument.Builder<>(name); @@ -78,33 +79,36 @@ public final class ItemDataArgument extends CommandArgument Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull ItemDataArgument of(final @NonNull String name) { return ItemDataArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type - * @return Created argument + * @return Created argument + * @since 1.5.0 */ public static @NonNull ItemDataArgument optional(final @NonNull String name) { return ItemDataArgument.newBuilder(name).asOptional().build(); } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * - * @param name Argument name + * @param name Argument name * @param defaultValue Default value - * @param Command sender type + * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull ItemDataArgument optional( final @NonNull String name, - final ItemStack defaultValue + final @NonNull ItemStack defaultValue ) { final String serializedDefault; if (defaultValue.hasTag()) { @@ -116,6 +120,11 @@ public final class ItemDataArgument extends CommandArgument sender type + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -123,13 +132,19 @@ public final class ItemDataArgument extends CommandArgument build() { - return new ItemDataArgument<>(this.isRequired(), this.getName(), this.getDefaultValue(), this.getSuggestionsProvider()); + return new ItemDataArgument<>( + this.isRequired(), + this.getName(), + this.getDefaultValue(), + this.getSuggestionsProvider() + ); } } diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/NbtPathArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/NbtPathArgument.java index f0170be0..eed4a009 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/NbtPathArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/NbtPathArgument.java @@ -59,45 +59,49 @@ public final class NbtPathArgument extends CommandArgument Command sender type * @return Created builder + * @since 1.5.0 */ public static NbtPathArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new NbtPathArgument.Builder<>(name); } /** - * Create a new required command argument + * Create a new required command argument. * * @param name Component name * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull NbtPathArgument of(final @NonNull String name) { return NbtPathArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type - * @return Created argument + * @return Created argument + * @since 1.5.0 */ public static @NonNull NbtPathArgument optional(final @NonNull String name) { return NbtPathArgument.newBuilder(name).asOptional().build(); } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * - * @param name Component name - * @param defaultTag Default tag value - * @param Command sender type + * @param name Component name + * @param defaultTag Default tag value + * @param Command sender type * @return Created component + * @since 1.5.0 */ public static @NonNull NbtPathArgument optional( final @NonNull String name, @@ -107,6 +111,12 @@ public final class NbtPathArgument extends CommandArgument sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -114,13 +124,19 @@ public final class NbtPathArgument extends CommandArgument build() { - return new NbtPathArgument<>(this.isRequired(), this.getName(), this.getDefaultValue(), this.getSuggestionsProvider()); + return new NbtPathArgument<>( + this.isRequired(), + this.getName(), + this.getDefaultValue(), + this.getSuggestionsProvider() + ); } } diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/NbtTagArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/NbtTagArgument.java index aea75351..229f9f5b 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/NbtTagArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/NbtTagArgument.java @@ -60,45 +60,49 @@ public final class NbtTagArgument extends CommandArgument { } /** - * Create a new builder + * Create a new builder. * * @param name Name of the component * @param Command sender type * @return Created builder + * @since 1.5.0 */ public static NbtTagArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new NbtTagArgument.Builder<>(name); } /** - * Create a new required command argument + * Create a new required command argument. * * @param name Component name * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull NbtTagArgument of(final @NonNull String name) { return NbtTagArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type - * @return Created argument + * @return Created argument + * @since 1.5.0 */ public static @NonNull NbtTagArgument optional(final @NonNull String name) { return NbtTagArgument.newBuilder(name).asOptional().build(); } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * - * @param name Component name - * @param defaultTag Default tag value - * @param Command sender type + * @param name Component name + * @param defaultTag Default tag value + * @param Command sender type * @return Created component + * @since 1.5.0 */ public static @NonNull NbtTagArgument optional( final @NonNull String name, @@ -108,6 +112,12 @@ public final class NbtTagArgument extends CommandArgument { } + /** + * Builder for {@link NbtTagArgument}. + * + * @param sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -115,9 +125,10 @@ public final class NbtTagArgument extends CommandArgument { } /** - * Builder a new example component + * Build a new nbt tag argument. * * @return Constructed component + * @since 1.5.0 */ @Override public @NonNull NbtTagArgument build() { diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ParticleEffectArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ParticleEffectArgument.java index 81c1527a..f47f2d04 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ParticleEffectArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ParticleEffectArgument.java @@ -36,7 +36,7 @@ import java.util.List; import java.util.function.BiFunction; /** - * An argument for any {@link net.minecraft.particle.ParticleEffect} + * An argument for any {@link net.minecraft.particle.ParticleEffect}. * * @param the sender type * @since 1.5.0 @@ -65,6 +65,7 @@ public final class ParticleEffectArgument extends CommandArgument Command sender type * @return Created builder + * @since 1.5.0 */ public static ParticleEffectArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new ParticleEffectArgument.Builder<>(name); @@ -76,38 +77,47 @@ public final class ParticleEffectArgument extends CommandArgument Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull ParticleEffectArgument of(final @NonNull String name) { return ParticleEffectArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type - * @return Created argument + * @return Created argument + * @since 1.5.0 */ public static @NonNull ParticleEffectArgument optional(final @NonNull String name) { return ParticleEffectArgument.newBuilder(name).asOptional().build(); } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * - * @param name Argument name - * @param defaultValue Default particle effect value - * @param Command sender type + * @param name Argument name + * @param defaultValue Default particle effect value + * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull ParticleEffectArgument optional( final @NonNull String name, - final ParticleEffect defaultValue + final @NonNull ParticleEffect defaultValue ) { return ParticleEffectArgument.newBuilder(name).asOptionalWithDefault(defaultValue.asString()).build(); } + /** + * Builder for {@link ParticleEffectArgument}. + * + * @param sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -115,13 +125,19 @@ public final class ParticleEffectArgument extends CommandArgument build() { - return new ParticleEffectArgument<>(this.isRequired(), this.getName(), this.getDefaultValue(), this.getSuggestionsProvider()); + return new ParticleEffectArgument<>( + this.isRequired(), + this.getName(), + this.getDefaultValue(), + this.getSuggestionsProvider() + ); } } diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/RegistryEntryArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/RegistryEntryArgument.java index 35be539e..e43f94bb 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/RegistryEntryArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/RegistryEntryArgument.java @@ -61,6 +61,7 @@ import static java.util.Objects.requireNonNull; * @since 1.5.0 */ public class RegistryEntryArgument extends CommandArgument { + private static final String NAMESPACE_MINECRAFT = "minecraft"; RegistryEntryArgument( @@ -77,46 +78,51 @@ public class RegistryEntryArgument extends CommandArgument { /** * Create a new builder. * - * @param name Name of the argument - * @param type The type of registry entry + * @param name Name of the argument + * @param type The type of registry entry * @param registry A key for the registry to get values from - * @param Command sender type - * @param Registry entry type + * @param Command sender type + * @param Registry entry type * @return Created builder + * @since 1.5.0 */ public static RegistryEntryArgument.@NonNull Builder newBuilder( final @NonNull String name, final @NonNull Class type, - final @NonNull RegistryKey> registry) { + final @NonNull RegistryKey> registry + ) { return new RegistryEntryArgument.Builder<>(registry, type, name); } /** * Create a new builder. * - * @param name Name of the argument - * @param type The type of registry entry + * @param name Name of the argument + * @param type The type of registry entry * @param registry A key for the registry to get values from - * @param Command sender type - * @param Registry entry type + * @param Command sender type + * @param Registry entry type * @return Created builder + * @since 1.5.0 */ public static RegistryEntryArgument.@NonNull Builder newBuilder( final @NonNull String name, final @NonNull TypeToken type, - final @NonNull RegistryKey> registry) { + final @NonNull RegistryKey> registry + ) { return new RegistryEntryArgument.Builder<>(registry, type, name); } /** * Create a new required command argument. * - * @param name Argument name - * @param type The type of registry entry + * @param name Argument name + * @param type The type of registry entry * @param registry A key for the registry to get values from - * @param Command sender type - * @param Registry entry type + * @param Command sender type + * @param Registry entry type * @return Created argument + * @since 1.5.0 */ public static @NonNull RegistryEntryArgument of( final @NonNull String name, @@ -127,14 +133,15 @@ public class RegistryEntryArgument extends CommandArgument { } /** - * Create a new optional command argument + * Create a new optional command argument. * - * @param name Argument name - * @param type The type of registry entry + * @param name Argument name + * @param type The type of registry entry * @param registry A key for the registry to get values from - * @param Command sender type - * @param Registry entry type - * @return Created argument + * @param Command sender type + * @param Registry entry type + * @return Created argument + * @since 1.5.0 */ public static @NonNull RegistryEntryArgument optional( final @NonNull String name, @@ -145,15 +152,16 @@ public class RegistryEntryArgument extends CommandArgument { } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * - * @param name Argument name - * @param type The type of registry entry - * @param registry A key for the registry to get values from + * @param name Argument name + * @param type The type of registry entry + * @param registry A key for the registry to get values from * @param defaultValue Default value - * @param Command sender type - * @param Registry entry type + * @param Command sender type + * @param Registry entry type * @return Created argument + * @since 1.5.0 */ public static @NonNull RegistryEntryArgument optional( final @NonNull String name, @@ -167,18 +175,21 @@ public class RegistryEntryArgument extends CommandArgument { } /** - * A parser for values stored in a {@link Registry} + * A parser for values stored in a {@link Registry}. * * @param Command sender type * @param Registry entry type + * @since 1.5.0 */ public static final class RegistryEntryParser implements ArgumentParser { + private final RegistryKey> registryIdent; /** * Create a new parser for registry entries. * * @param registryIdent the registry identifier + * @since 1.5.0 */ public RegistryEntryParser(final RegistryKey> registryIdent) { this.registryIdent = requireNonNull(registryIdent, "registryIdent"); @@ -253,8 +264,10 @@ public class RegistryEntryArgument extends CommandArgument { } /** - * Get the registry associated with this parser + * Get the registry associated with this parser. + * * @return the registry + * @since 1.5.0 */ public RegistryKey> getRegistry() { return this.registryIdent; @@ -267,8 +280,10 @@ public class RegistryEntryArgument extends CommandArgument { * * @param The sender type * @param The registry value type + * @since 1.5.0 */ public static final class Builder extends CommandArgument.TypedBuilder> { + private final RegistryKey> registryIdent; Builder( @@ -300,10 +315,13 @@ public class RegistryEntryArgument extends CommandArgument { this.getSuggestionsProvider() ); } + } /** * An exception thrown when an entry in a registry could not be found. + * + * @since 1.5.0 */ private static final class UnknownEntryException extends ParserException { diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ScoreboardCriterionArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ScoreboardCriterionArgument.java index 96465dcd..881dabd1 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ScoreboardCriterionArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ScoreboardCriterionArgument.java @@ -65,6 +65,7 @@ public final class ScoreboardCriterionArgument extends CommandArgument Command sender type * @return Created builder + * @since 1.5.0 */ public static ScoreboardCriterionArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new ScoreboardCriterionArgument.Builder<>(name); @@ -76,29 +77,32 @@ public final class ScoreboardCriterionArgument extends CommandArgument Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull ScoreboardCriterionArgument of(final @NonNull String name) { return ScoreboardCriterionArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type - * @return Created argument + * @return Created argument + * @since 1.5.0 */ public static @NonNull ScoreboardCriterionArgument optional(final @NonNull String name) { return ScoreboardCriterionArgument.newBuilder(name).asOptional().build(); } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * - * @param name Argument name - * @param defaultCriterion Default criterion - * @param Command sender type + * @param name Argument name + * @param defaultCriterion Default criterion + * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull ScoreboardCriterionArgument optional( final @NonNull String name, @@ -108,6 +112,12 @@ public final class ScoreboardCriterionArgument extends CommandArgument sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -115,9 +125,10 @@ public final class ScoreboardCriterionArgument extends CommandArgument build() { diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ScoreboardOperationArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ScoreboardOperationArgument.java index a3ca452b..57151574 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ScoreboardOperationArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/ScoreboardOperationArgument.java @@ -67,6 +67,7 @@ public final class ScoreboardOperationArgument extends CommandArgument Command sender type * @return Created builder + * @since 1.5.0 */ public static ScoreboardOperationArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new ScoreboardOperationArgument.Builder<>(name); @@ -78,22 +79,30 @@ public final class ScoreboardOperationArgument extends CommandArgument Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull ScoreboardOperationArgument of(final @NonNull String name) { return ScoreboardOperationArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type - * @return Created argument + * @return Created argument + * @since 1.5.0 */ public static @NonNull ScoreboardOperationArgument optional(final @NonNull String name) { return ScoreboardOperationArgument.newBuilder(name).asOptional().build(); } + /** + * Builder for {@link ScoreboardOperationArgument}. + * + * @param sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -101,9 +110,10 @@ public final class ScoreboardOperationArgument extends CommandArgument build() { diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/SidedArgumentParser.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/SidedArgumentParser.java index c3ea21d8..a7a63c73 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/SidedArgumentParser.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/SidedArgumentParser.java @@ -42,6 +42,7 @@ import java.util.Queue; * @param command sender type * @param intermediate type to resolve * @param resolved type + * @since 1.5.0 */ abstract class SidedArgumentParser implements ArgumentParser { @@ -73,9 +74,10 @@ abstract class SidedArgumentParser implements ArgumentParser { * Resolve the final value for this argument when running on the client. * * @param context Command context - * @param source The command source - * @param value parsed intermediate value + * @param source The command source + * @param value parsed intermediate value * @return a resolved value + * @since 1.5.0 */ protected abstract ArgumentParseResult resolveClient(CommandContext context, CommandSource source, I value); @@ -83,9 +85,10 @@ abstract class SidedArgumentParser implements ArgumentParser { * Resolve the final value for this argument when running on the server. * * @param context Command context - * @param source The command source - * @param value Parsed intermediate value + * @param source The command source + * @param value Parsed intermediate value * @return a resolved value + * @since 1.5.0 */ protected abstract ArgumentParseResult resolveServer(CommandContext context, CommandSource source, I value); diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/StatusEffectArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/StatusEffectArgument.java index 608b8629..2491ac7d 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/StatusEffectArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/StatusEffectArgument.java @@ -37,7 +37,7 @@ import java.util.List; import java.util.function.BiFunction; /** - * An argument parsing a status effect from the {@link net.minecraft.util.registry.Registry#STATUS_EFFECT status effect registry} + * An argument parsing a status effect from the {@link net.minecraft.util.registry.Registry#STATUS_EFFECT status effect registry}. * * @param the sender type * @since 1.5.0 @@ -66,6 +66,7 @@ public final class StatusEffectArgument extends CommandArgument Command sender type * @return Created builder + * @since 1.5.0 */ public static StatusEffectArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new StatusEffectArgument.Builder<>(name); @@ -77,29 +78,32 @@ public final class StatusEffectArgument extends CommandArgument Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull StatusEffectArgument of(final @NonNull String name) { return StatusEffectArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type - * @return Created argument + * @return Created argument + * @since 1.5.0 */ public static @NonNull StatusEffectArgument optional(final @NonNull String name) { return StatusEffectArgument.newBuilder(name).asOptional().build(); } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * - * @param name Argument name + * @param name Argument name * @param defaultValue Default value - * @param Command sender type + * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull StatusEffectArgument optional( final @NonNull String name, @@ -111,6 +115,12 @@ public final class StatusEffectArgument extends CommandArgument sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -118,9 +128,10 @@ public final class StatusEffectArgument extends CommandArgument build() { diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/TeamArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/TeamArgument.java index 1057b805..ceebb758 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/TeamArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/TeamArgument.java @@ -75,6 +75,7 @@ public final class TeamArgument extends CommandArgument { * @param name Name of the argument * @param Command sender type * @return Created builder + * @since 1.5.0 */ public static TeamArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new TeamArgument.Builder<>(name); @@ -86,29 +87,32 @@ public final class TeamArgument extends CommandArgument { * @param name Component name * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull TeamArgument of(final @NonNull String name) { return TeamArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type - * @return Created argument + * @return Created argument + * @since 1.5.0 */ public static @NonNull TeamArgument optional(final @NonNull String name) { return TeamArgument.newBuilder(name).asOptional().build(); } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * - * @param name Argument name + * @param name Argument name * @param defaultValue Default value - * @param Command sender type + * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull TeamArgument optional( final @NonNull String name, @@ -117,6 +121,12 @@ public final class TeamArgument extends CommandArgument { return TeamArgument.newBuilder(name).asOptionalWithDefault(defaultValue.name()).build(); } + /** + * Argument parser for {@link Team}. + * + * @param sender type + * @since 1.5.0 + */ public static final class TeamParser extends SidedArgumentParser { @Override @@ -140,9 +150,11 @@ public final class TeamArgument extends CommandArgument { } @Override - protected ArgumentParseResult resolveClient(final CommandContext context, - final CommandSource source, - final String value) { + protected ArgumentParseResult resolveClient( + final @NonNull CommandContext context, + final @NonNull CommandSource source, + final @NonNull String value + ) { final Team result = MinecraftClient.getInstance().getNetworkHandler().getWorld().getScoreboard().getTeam(value); if (result == null) { return ArgumentParseResult.failure(new UnknownTeamException(context, value)); @@ -151,9 +163,11 @@ public final class TeamArgument extends CommandArgument { } @Override - protected ArgumentParseResult resolveServer(final CommandContext context, - final CommandSource source, - final String value) { + protected ArgumentParseResult resolveServer( + final @NonNull CommandContext context, + final @NonNull CommandSource source, + final @NonNull String value + ) { final Team result = ((ServerCommandSource) source).getWorld().getScoreboard().getTeam(value); if (result == null) { return ArgumentParseResult.failure(new UnknownTeamException(context, value)); @@ -163,6 +177,12 @@ public final class TeamArgument extends CommandArgument { } + /** + * Builder for {@link TeamArgument}. + * + * @param sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -170,9 +190,10 @@ public final class TeamArgument extends CommandArgument { } /** - * Build a new criterion argument + * Build a new team argument. * * @return Constructed argument + * @since 1.5.0 */ @Override public @NonNull TeamArgument build() { @@ -181,7 +202,13 @@ public final class TeamArgument extends CommandArgument { } + /** + * Exception for when a team cannot be found for supplied input. + * + * @since 1.5.0 + */ public static final class UnknownTeamException extends ParserException { + private static final long serialVersionUID = 4249139487412603424L; UnknownTeamException( diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/TimeArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/TimeArgument.java index 7b49b366..69529d6e 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/TimeArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/TimeArgument.java @@ -34,7 +34,7 @@ import java.util.List; import java.util.function.BiFunction; /** - * An argument for in-game time + * An argument for in-game time. * * @param the sender type * @since 1.5.0 @@ -63,6 +63,7 @@ public final class TimeArgument extends CommandArgument { * @param name Name of the argument * @param Command sender type * @return Created builder + * @since 1.5.0 */ public static TimeArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new TimeArgument.Builder<>(name); @@ -74,29 +75,32 @@ public final class TimeArgument extends CommandArgument { * @param name Component name * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull TimeArgument of(final @NonNull String name) { return TimeArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull TimeArgument optional(final @NonNull String name) { return TimeArgument.newBuilder(name).asOptional().build(); } /** - * Create a new optional command argument with a default value + * Create a new optional command argument with a default value. * * @param name Argument name * @param defaultTime Default time, in ticks * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull TimeArgument optional( final @NonNull String name, @@ -106,6 +110,12 @@ public final class TimeArgument extends CommandArgument { } + /** + * Builder for {@link TimeArgument}. + * + * @param sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -113,9 +123,10 @@ public final class TimeArgument extends CommandArgument { } /** - * Build a new time argument + * Build a new time argument. * * @return Constructed argument + * @since 1.5.0 */ @Override public @NonNull TimeArgument build() { diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/package-info.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/package-info.java index 651dec3e..328d9c05 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/package-info.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/package-info.java @@ -24,5 +24,7 @@ /** * Arguments for the Fabric environment. + * + * @since 1.5.0 */ package cloud.commandframework.fabric.argument; diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/MessageArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/MessageArgument.java index 22bce41c..77545c23 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/MessageArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/MessageArgument.java @@ -64,6 +64,7 @@ public final class MessageArgument extends CommandArgument { * @param name Name of the argument * @param Command sender type * @return Created builder + * @since 1.5.0 */ public static MessageArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new MessageArgument.Builder<>(name); @@ -75,6 +76,7 @@ public final class MessageArgument extends CommandArgument { * @param name Component name * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull MessageArgument of(final @NonNull String name) { return MessageArgument.newBuilder(name).asRequired().build(); @@ -86,6 +88,7 @@ public final class MessageArgument extends CommandArgument { * @param name Component name * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull MessageArgument optional(final @NonNull String name) { return MessageArgument.newBuilder(name).asOptional().build(); @@ -98,15 +101,22 @@ public final class MessageArgument extends CommandArgument { * @param defaultValue Default value * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull MessageArgument optional( final @NonNull String name, - final String defaultValue + final @NonNull String defaultValue ) { return MessageArgument.newBuilder(name).asOptionalWithDefault(defaultValue).build(); } + /** + * Builder for {@link MessageArgument}. + * + * @param sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -114,9 +124,10 @@ public final class MessageArgument extends CommandArgument { } /** - * Build a new criterion argument + * Build a new message argument. * * @return Constructed argument + * @since 1.5.0 */ @Override public @NonNull MessageArgument build() { diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/MultipleEntitySelectorArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/MultipleEntitySelectorArgument.java index a41f54d2..84cc6845 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/MultipleEntitySelectorArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/MultipleEntitySelectorArgument.java @@ -63,6 +63,7 @@ public final class MultipleEntitySelectorArgument extends CommandArgument Command sender type * @return Created builder + * @since 1.5.0 */ public static MultipleEntitySelectorArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new MultipleEntitySelectorArgument.Builder<>(name); @@ -74,6 +75,7 @@ public final class MultipleEntitySelectorArgument extends CommandArgument Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull MultipleEntitySelectorArgument of(final @NonNull String name) { return MultipleEntitySelectorArgument.newBuilder(name).asRequired().build(); @@ -85,11 +87,18 @@ public final class MultipleEntitySelectorArgument extends CommandArgument Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull MultipleEntitySelectorArgument optional(final @NonNull String name) { return MultipleEntitySelectorArgument.newBuilder(name).asOptional().build(); } + /** + * Builder for {@link MultipleEntitySelectorArgument}. + * + * @param sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -97,9 +106,10 @@ public final class MultipleEntitySelectorArgument extends CommandArgument build() { diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/MultiplePlayerSelectorArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/MultiplePlayerSelectorArgument.java index ae3d0c25..3daaa701 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/MultiplePlayerSelectorArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/MultiplePlayerSelectorArgument.java @@ -63,6 +63,7 @@ public final class MultiplePlayerSelectorArgument extends CommandArgument Command sender type * @return Created builder + * @since 1.5.0 */ public static MultiplePlayerSelectorArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new MultiplePlayerSelectorArgument.Builder<>(name); @@ -74,22 +75,30 @@ public final class MultiplePlayerSelectorArgument extends CommandArgument Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull MultiplePlayerSelectorArgument of(final @NonNull String name) { return MultiplePlayerSelectorArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull MultiplePlayerSelectorArgument optional(final @NonNull String name) { return MultiplePlayerSelectorArgument.newBuilder(name).asOptional().build(); } + /** + * Builder for {@link MultiplePlayerSelectorArgument}. + * + * @param sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -97,9 +106,10 @@ public final class MultiplePlayerSelectorArgument extends CommandArgument build() { diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/SingleEntitySelectorArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/SingleEntitySelectorArgument.java index 608c0b9e..42f7719b 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/SingleEntitySelectorArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/SingleEntitySelectorArgument.java @@ -63,6 +63,7 @@ public final class SingleEntitySelectorArgument extends CommandArgument Command sender type * @return Created builder + * @since 1.5.0 */ public static SingleEntitySelectorArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new SingleEntitySelectorArgument.Builder<>(name); @@ -74,22 +75,30 @@ public final class SingleEntitySelectorArgument extends CommandArgument Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull SingleEntitySelectorArgument of(final @NonNull String name) { return SingleEntitySelectorArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull SingleEntitySelectorArgument optional(final @NonNull String name) { return SingleEntitySelectorArgument.newBuilder(name).asOptional().build(); } + /** + * Builder for {@link SingleEntitySelectorArgument}. + * + * @param sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -97,9 +106,10 @@ public final class SingleEntitySelectorArgument extends CommandArgument build() { diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/SinglePlayerSelectorArgument.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/SinglePlayerSelectorArgument.java index 6facd7b9..c283706e 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/SinglePlayerSelectorArgument.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/argument/server/SinglePlayerSelectorArgument.java @@ -63,6 +63,7 @@ public final class SinglePlayerSelectorArgument extends CommandArgument Command sender type * @return Created builder + * @since 1.5.0 */ public static SinglePlayerSelectorArgument.@NonNull Builder newBuilder(final @NonNull String name) { return new SinglePlayerSelectorArgument.Builder<>(name); @@ -74,22 +75,30 @@ public final class SinglePlayerSelectorArgument extends CommandArgument Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull SinglePlayerSelectorArgument of(final @NonNull String name) { return SinglePlayerSelectorArgument.newBuilder(name).asRequired().build(); } /** - * Create a new optional command argument + * Create a new optional command argument. * * @param name Component name * @param Command sender type * @return Created argument + * @since 1.5.0 */ public static @NonNull SinglePlayerSelectorArgument optional(final @NonNull String name) { return SinglePlayerSelectorArgument.newBuilder(name).asOptional().build(); } + /** + * Builder for {@link SinglePlayerSelectorArgument}. + * + * @param sender type + * @since 1.5.0 + */ public static final class Builder extends TypedBuilder> { Builder(final @NonNull String name) { @@ -97,9 +106,10 @@ public final class SinglePlayerSelectorArgument extends CommandArgument build() { diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/Message.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/Message.java index 9bac72c4..d4a3b4cf 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/Message.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/Message.java @@ -32,6 +32,8 @@ import java.util.Collection; /** * A parsed message. + * + * @since 1.5.0 */ public interface Message { @@ -39,6 +41,7 @@ public interface Message { * Get the collection of entities mentioned in this message. * * @return the mentioned entities + * @since 1.5.0 */ @NonNull Collection getMentionedEntities(); @@ -46,6 +49,7 @@ public interface Message { * Get the parsed text contents of this message. * * @return the parsed text + * @since 1.5.0 */ @NonNull Text getContents(); diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/MinecraftTime.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/MinecraftTime.java index 348c2fa9..4e1fb36c 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/MinecraftTime.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/MinecraftTime.java @@ -38,6 +38,7 @@ import static java.util.Objects.requireNonNull; * @since 1.5.0 */ public final class MinecraftTime { + private static final MinecraftTime ZERO = new MinecraftTime(0); private final long ticks; @@ -47,6 +48,7 @@ public final class MinecraftTime { * * @param ticks the number of ticks * @return a time holder + * @since 1.5.0 */ public static MinecraftTime of(final long ticks) { return ticks == 0 ? ZERO : new MinecraftTime(ticks); @@ -56,8 +58,9 @@ public final class MinecraftTime { * Given an amount of time in another unit, create a game time holding the number of ticks expected to pass in that time. * * @param amount the amount of time - * @param unit the unit + * @param unit the unit * @return a time holder + * @since 1.5.0 */ public static MinecraftTime of(final long amount, final TemporalUnit unit) { requireNonNull(unit, "unit"); @@ -68,8 +71,9 @@ public final class MinecraftTime { * Given an amount of time in another unit, create a game time holding the number of ticks expected to pass in that time. * * @param amount the amount of time - * @param unit the unit + * @param unit the unit * @return a time holder + * @since 1.5.0 */ public static MinecraftTime of(final long amount, final TimeUnit unit) { requireNonNull(unit, "unit"); @@ -87,6 +91,7 @@ public final class MinecraftTime { * See {@link #getLongTicks()} for the full contents.

* * @return the time in ticks + * @since 1.5.0 */ public int getTicks() { return (int) this.ticks; @@ -96,6 +101,7 @@ public final class MinecraftTime { * Get the number of in-game ticks represented by this time. * * @return the time in ticks + * @since 1.5.0 */ public long getLongTicks() { return this.ticks; @@ -106,6 +112,7 @@ public final class MinecraftTime { * * @param unit the target unit * @return the target duration, as represented by the provided unit + * @since 1.5.0 */ public long convertTo(final TemporalUnit unit) { return this.ticks * 50 / unit.getDuration().toMillis(); @@ -116,6 +123,7 @@ public final class MinecraftTime { * * @param unit the target unit * @return the target duration, as represented by the provided unit + * @since 1.5.0 */ public long convertTo(final TimeUnit unit) { return unit.convert(this.ticks * 50, TimeUnit.MILLISECONDS); diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/MultipleEntitySelector.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/MultipleEntitySelector.java index f751833b..6df32b93 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/MultipleEntitySelector.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/MultipleEntitySelector.java @@ -31,6 +31,8 @@ import java.util.Collection; /** * A selector for multiple entities. + * + * @since 1.5.0 */ public final class MultipleEntitySelector implements Selector { @@ -44,6 +46,7 @@ public final class MultipleEntitySelector implements Selector { * @param inputString input string * @param entitySelector entity selector * @param selectedEntities selected entities + * @since 1.5.0 */ public MultipleEntitySelector( final @NonNull String inputString, diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/MultiplePlayerSelector.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/MultiplePlayerSelector.java index 17e3dbc4..c352ea1c 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/MultiplePlayerSelector.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/MultiplePlayerSelector.java @@ -31,6 +31,8 @@ import java.util.Collection; /** * A selector for multiple players. + * + * @since 1.5.0 */ public final class MultiplePlayerSelector implements Selector { @@ -44,6 +46,7 @@ public final class MultiplePlayerSelector implements Selector Value type + * @since 1.5.0 */ public interface Selector { @@ -41,6 +42,7 @@ public interface Selector { * Get the raw string associated with the selector. * * @return the input + * @since 1.5.0 */ String getInput(); @@ -48,6 +50,7 @@ public interface Selector { * If this value came from a parsed selector, this will provide the details of that selector. * * @return the selector + * @since 1.5.0 */ @Nullable EntitySelector getSelector(); @@ -57,6 +60,7 @@ public interface Selector { *

A successfully parsed selector must match one or more values

* * @return all matched entities + * @since 1.5.0 */ Collection get(); @@ -64,6 +68,7 @@ public interface Selector { * A specialized selector that can only return one value. * * @param the value type + * @since 1.5.0 */ interface Single extends Selector { @@ -72,7 +77,14 @@ public interface Selector { return Collections.singletonList(this.getSingle()); } + /** + * Get the single value from this selector. + * + * @return the value + * @since 1.5.0 + */ V getSingle(); + } } diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/SingleEntitySelector.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/SingleEntitySelector.java index 45f47334..6a34e4a3 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/SingleEntitySelector.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/SingleEntitySelector.java @@ -29,6 +29,8 @@ import org.checkerframework.checker.nullness.qual.NonNull; /** * A selector for a single entity. + * + * @since 1.5.0 */ public final class SingleEntitySelector implements Selector.Single { @@ -42,6 +44,7 @@ public final class SingleEntitySelector implements Selector.Single { * @param inputString input string * @param entitySelector entity selector * @param selectedEntity selected entity + * @since 1.5.0 */ public SingleEntitySelector( final @NonNull String inputString, diff --git a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/SinglePlayerSelector.java b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/SinglePlayerSelector.java index 428fe25c..e3ce0543 100644 --- a/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/SinglePlayerSelector.java +++ b/cloud-minecraft/cloud-fabric/src/main/java/cloud/commandframework/fabric/data/SinglePlayerSelector.java @@ -29,6 +29,8 @@ import org.checkerframework.checker.nullness.qual.NonNull; /** * A selector for a single player. + * + * @since 1.5.0 */ public final class SinglePlayerSelector implements Selector.Single { @@ -42,6 +44,7 @@ public final class SinglePlayerSelector implements Selector.Single