From bc3877b87a26069df0d61feb8ba62eea4bf6d491 Mon Sep 17 00:00:00 2001 From: efekos Date: Sun, 26 Nov 2023 22:43:13 +0300 Subject: [PATCH] update JavaDoc --- docs/allclasses-index.html | 13 +- docs/allpackages-index.html | 4 +- docs/constant-values.html | 4 +- docs/help-doc.html | 4 +- docs/index-files/index-1.html | 8 +- docs/index-files/index-10.html | 4 +- docs/index-files/index-11.html | 4 +- docs/index-files/index-12.html | 4 +- docs/index-files/index-13.html | 4 +- docs/index-files/index-14.html | 4 +- docs/index-files/index-15.html | 4 +- docs/index-files/index-16.html | 4 +- docs/index-files/index-17.html | 4 +- docs/index-files/index-18.html | 8 +- docs/index-files/index-19.html | 8 +- docs/index-files/index-2.html | 4 +- docs/index-files/index-20.html | 4 +- docs/index-files/index-21.html | 4 +- docs/index-files/index-22.html | 4 +- docs/index-files/index-23.html | 4 +- docs/index-files/index-3.html | 12 +- docs/index-files/index-4.html | 4 +- docs/index-files/index-5.html | 8 +- docs/index-files/index-6.html | 4 +- docs/index-files/index-7.html | 20 ++- docs/index-files/index-8.html | 8 +- docs/index-files/index-9.html | 8 +- docs/index.html | 4 +- .../simpler/Metrics.AdvancedBarChart.html | 4 +- .../efekos/simpler/Metrics.AdvancedPie.html | 4 +- .../efekos/simpler/Metrics.CustomChart.html | 4 +- .../efekos/simpler/Metrics.DrilldownPie.html | 4 +- .../Metrics.JsonObjectBuilder.JsonObject.html | 4 +- .../simpler/Metrics.JsonObjectBuilder.html | 4 +- .../efekos/simpler/Metrics.MetricsBase.html | 4 +- .../simpler/Metrics.MultiLineChart.html | 4 +- .../simpler/Metrics.SimpleBarChart.html | 4 +- docs/me/efekos/simpler/Metrics.SimplePie.html | 4 +- .../simpler/Metrics.SingleLineChart.html | 4 +- docs/me/efekos/simpler/Metrics.html | 4 +- docs/me/efekos/simpler/Simpler.html | 4 +- docs/me/efekos/simpler/Utilities.html | 4 +- .../efekos/simpler/annotations/Command.html | 4 +- .../efekos/simpler/annotations/LeftClick.html | 4 +- .../me/efekos/simpler/annotations/Listen.html | 4 +- .../simpler/annotations/RightClick.html | 4 +- .../simpler/annotations/package-summary.html | 4 +- .../simpler/annotations/package-tree.html | 4 +- .../efekos/simpler/commands/BaseCommand.html | 4 +- .../commands/CommandExecuteContext.html | 132 +++++++----------- .../simpler/commands/CommandManager.html | 4 +- .../efekos/simpler/commands/CommandTree.html | 4 +- .../efekos/simpler/commands/CoreCommand.html | 4 +- .../efekos/simpler/commands/SubCommand.html | 4 +- .../simpler/commands/node/ArgumentNode.html | 4 +- .../commands/node/CommandExecutive.html | 4 +- .../simpler/commands/node/CommandNode.html | 4 +- .../node/impl/IntegerArgumentNode.html | 4 +- .../simpler/commands/node/impl/LabelNode.html | 4 +- .../commands/node/impl/ListArgumentNode.html | 4 +- .../node/impl/PlayerArgumentNode.html | 4 +- .../node/impl/StringArgumentNode.html | 4 +- .../commands/node/impl/package-summary.html | 4 +- .../commands/node/impl/package-tree.html | 4 +- .../commands/node/package-summary.html | 4 +- .../simpler/commands/node/package-tree.html | 4 +- .../simpler/commands/package-summary.html | 23 +-- .../efekos/simpler/commands/package-tree.html | 10 +- .../simpler/commands/syntax/Argument.html | 4 +- .../commands/syntax/ArgumentHandleResult.html | 4 +- .../commands/syntax/ArgumentPriority.html | 4 +- .../simpler/commands/syntax/Syntax.html | 4 +- .../commands/syntax/impl/IntegerArgument.html | 4 +- .../commands/syntax/impl/ListArgument.html | 4 +- .../commands/syntax/impl/PlayerArgument.html | 4 +- .../commands/syntax/impl/StringArgument.html | 4 +- .../commands/syntax/impl/package-summary.html | 4 +- .../commands/syntax/impl/package-tree.html | 4 +- .../commands/syntax/package-summary.html | 4 +- .../simpler/commands/syntax/package-tree.html | 4 +- docs/me/efekos/simpler/config/JsonConfig.html | 4 +- .../simpler/config/ListDataManager.html | 4 +- .../efekos/simpler/config/MapDataManager.html | 4 +- .../config/MessageConfiguration.Builder.html | 4 +- .../simpler/config/MessageConfiguration.html | 4 +- docs/me/efekos/simpler/config/Storable.html | 4 +- docs/me/efekos/simpler/config/YamlConfig.html | 4 +- .../simpler/config/package-summary.html | 4 +- .../efekos/simpler/config/package-tree.html | 4 +- docs/me/efekos/simpler/events/ItemEvents.html | 4 +- docs/me/efekos/simpler/events/MenuEvents.html | 4 +- .../simpler/events/package-summary.html | 4 +- .../efekos/simpler/events/package-tree.html | 4 +- .../exception/InvalidAnnotationException.html | 4 +- .../simpler/exception/NoPluginException.html | 4 +- .../simpler/exception/package-summary.html | 4 +- .../simpler/exception/package-tree.html | 4 +- docs/me/efekos/simpler/items/CustomItem.html | 4 +- docs/me/efekos/simpler/items/ItemContent.html | 4 +- docs/me/efekos/simpler/items/ItemManager.html | 4 +- .../items/compound/BannerCompound.html | 4 +- .../items/compound/BannerPatternCompound.html | 4 +- .../compound/CompassPositionCompound.html | 4 +- .../simpler/items/compound/Display.html | 4 +- .../items/compound/EnchantmentCompound.html | 4 +- .../items/compound/ExplosionCompound.html | 4 +- .../items/compound/FireworkCompound.html | 4 +- .../items/compound/LeatherArmorDisplay.html | 4 +- .../items/compound/PotionEffectCompound.html | 4 +- .../items/compound/ShulkerBoxCompound.html | 4 +- .../SuspiciousStewEffectCompound.html | 4 +- .../simpler/items/compound/TextCompound.html | 4 +- .../simpler/items/compound/TrimCompound.html | 4 +- .../items/compound/package-summary.html | 4 +- .../simpler/items/compound/package-tree.html | 4 +- .../efekos/simpler/items/package-summary.html | 4 +- .../me/efekos/simpler/items/package-tree.html | 4 +- .../simpler/items/tag/AxolotlBucketTag.html | 4 +- .../efekos/simpler/items/tag/BannerTag.html | 4 +- docs/me/efekos/simpler/items/tag/BookTag.html | 4 +- .../efekos/simpler/items/tag/BundleTag.html | 4 +- .../efekos/simpler/items/tag/CompassTag.html | 4 +- .../efekos/simpler/items/tag/CrossbowTag.html | 4 +- .../items/tag/EnchantmentStorageTag.html | 4 +- .../simpler/items/tag/FireworkEffectTag.html | 4 +- .../efekos/simpler/items/tag/FireworkTag.html | 4 +- .../efekos/simpler/items/tag/GoatHornTag.html | 4 +- docs/me/efekos/simpler/items/tag/ItemTag.html | 4 +- .../simpler/items/tag/KnowledgeBookTag.html | 4 +- docs/me/efekos/simpler/items/tag/MapTag.html | 4 +- .../efekos/simpler/items/tag/PotionTag.html | 4 +- .../simpler/items/tag/ShulkerBoxTag.html | 4 +- .../me/efekos/simpler/items/tag/SkullTag.html | 4 +- .../simpler/items/tag/SuspiciousStewTag.html | 4 +- docs/me/efekos/simpler/items/tag/TrimTag.html | 4 +- .../simpler/items/tag/package-summary.html | 4 +- .../simpler/items/tag/package-tree.html | 4 +- docs/me/efekos/simpler/menu/Menu.html | 4 +- docs/me/efekos/simpler/menu/MenuData.html | 4 +- docs/me/efekos/simpler/menu/MenuManager.html | 4 +- .../me/efekos/simpler/menu/PaginatedMenu.html | 4 +- .../efekos/simpler/menu/package-summary.html | 4 +- docs/me/efekos/simpler/menu/package-tree.html | 4 +- docs/me/efekos/simpler/package-summary.html | 4 +- docs/me/efekos/simpler/package-tree.html | 4 +- .../simpler/translation/TranslateManager.html | 4 +- .../simpler/translation/package-summary.html | 4 +- .../simpler/translation/package-tree.html | 4 +- docs/member-search-index.js | 2 +- docs/overview-summary.html | 4 +- docs/overview-tree.html | 10 +- docs/serialized-form.html | 4 +- 152 files changed, 384 insertions(+), 438 deletions(-) diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html index d431ccb..0fec414 100644 --- a/docs/allclasses-index.html +++ b/docs/allclasses-index.html @@ -1,11 +1,11 @@ - + All Classes and Interfaces - + @@ -55,7 +55,7 @@

All Classes and Interfaces

-
+
Class
@@ -100,11 +100,8 @@

All Classes and Interfaces<
Used to give information about a command class.
-
CommandExecuteContext
-
-
Creates a new context to use for running CommandExecutives of - CommandNodes.
-
+
CommandExecuteContext
+
 
CommandExecutive
Main interface used by CommandNodes as 'a method to run when someone executes me'.
diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html index f96ee48..326664b 100644 --- a/docs/allpackages-index.html +++ b/docs/allpackages-index.html @@ -1,11 +1,11 @@ - + All Packages - + diff --git a/docs/constant-values.html b/docs/constant-values.html index 47a4aaa..ca414fa 100644 --- a/docs/constant-values.html +++ b/docs/constant-values.html @@ -1,11 +1,11 @@ - + Constant Field Values - + diff --git a/docs/help-doc.html b/docs/help-doc.html index 4d5c195..a3c1b69 100644 --- a/docs/help-doc.html +++ b/docs/help-doc.html @@ -1,11 +1,11 @@ - + API Help - + diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html index 93599e8..9deba6f 100644 --- a/docs/index-files/index-1.html +++ b/docs/index-files/index-1.html @@ -1,11 +1,11 @@ - + A-Index - + @@ -119,10 +119,6 @@

A

Appends a null field to the JSON.
-
args() - Method in record class me.efekos.simpler.commands.CommandExecuteContext
-
-
Returns the value of the args record component.
-
Argument - Class in me.efekos.simpler.commands.syntax
Used for your custom arguments.
diff --git a/docs/index-files/index-10.html b/docs/index-files/index-10.html index fbdebaa..f28403b 100644 --- a/docs/index-files/index-10.html +++ b/docs/index-files/index-10.html @@ -1,11 +1,11 @@ - + J-Index - + diff --git a/docs/index-files/index-11.html b/docs/index-files/index-11.html index c6990d1..c4fb743 100644 --- a/docs/index-files/index-11.html +++ b/docs/index-files/index-11.html @@ -1,11 +1,11 @@ - + K-Index - + diff --git a/docs/index-files/index-12.html b/docs/index-files/index-12.html index 28078cb..4eabfec 100644 --- a/docs/index-files/index-12.html +++ b/docs/index-files/index-12.html @@ -1,11 +1,11 @@ - + L-Index - + diff --git a/docs/index-files/index-13.html b/docs/index-files/index-13.html index d46db09..68234f5 100644 --- a/docs/index-files/index-13.html +++ b/docs/index-files/index-13.html @@ -1,11 +1,11 @@ - + M-Index - + diff --git a/docs/index-files/index-14.html b/docs/index-files/index-14.html index 89a8b8e..a3be4ba 100644 --- a/docs/index-files/index-14.html +++ b/docs/index-files/index-14.html @@ -1,11 +1,11 @@ - + N-Index - + diff --git a/docs/index-files/index-15.html b/docs/index-files/index-15.html index 016d8fe..c7f14d6 100644 --- a/docs/index-files/index-15.html +++ b/docs/index-files/index-15.html @@ -1,11 +1,11 @@ - + O-Index - + diff --git a/docs/index-files/index-16.html b/docs/index-files/index-16.html index bc2fa48..04536eb 100644 --- a/docs/index-files/index-16.html +++ b/docs/index-files/index-16.html @@ -1,11 +1,11 @@ - + P-Index - + diff --git a/docs/index-files/index-17.html b/docs/index-files/index-17.html index a902628..6837981 100644 --- a/docs/index-files/index-17.html +++ b/docs/index-files/index-17.html @@ -1,11 +1,11 @@ - + R-Index - + diff --git a/docs/index-files/index-18.html b/docs/index-files/index-18.html index 06a19b2..fe445ee 100644 --- a/docs/index-files/index-18.html +++ b/docs/index-files/index-18.html @@ -1,11 +1,11 @@ - + S-Index - + @@ -65,10 +65,6 @@

S

Saves the item data to the path given.
-
sender() - Method in record class me.efekos.simpler.commands.CommandExecuteContext
-
-
Returns the value of the sender record component.
-
set(String, Object) - Method in class me.efekos.simpler.menu.MenuData
Sets a value for the key given.
diff --git a/docs/index-files/index-19.html b/docs/index-files/index-19.html index 30f1101..5aa092e 100644 --- a/docs/index-files/index-19.html +++ b/docs/index-files/index-19.html @@ -1,11 +1,11 @@ - + T-Index - + @@ -79,10 +79,6 @@

T

Converts a TextComponent to a TextCompound.
-
toString() - Method in record class me.efekos.simpler.commands.CommandExecuteContext
-
-
Returns a string representation of this record class.
-
toString() - Method in class me.efekos.simpler.commands.syntax.Argument
Returns a string representation of this Argument.
diff --git a/docs/index-files/index-2.html b/docs/index-files/index-2.html index f110ecc..aeea629 100644 --- a/docs/index-files/index-2.html +++ b/docs/index-files/index-2.html @@ -1,11 +1,11 @@ - + B-Index - + diff --git a/docs/index-files/index-20.html b/docs/index-files/index-20.html index 41a881f..0eefb91 100644 --- a/docs/index-files/index-20.html +++ b/docs/index-files/index-20.html @@ -1,11 +1,11 @@ - + U-Index - + diff --git a/docs/index-files/index-21.html b/docs/index-files/index-21.html index 080ccdc..52fb6ea 100644 --- a/docs/index-files/index-21.html +++ b/docs/index-files/index-21.html @@ -1,11 +1,11 @@ - + V-Index - + diff --git a/docs/index-files/index-22.html b/docs/index-files/index-22.html index cea8d0f..ff9e6be 100644 --- a/docs/index-files/index-22.html +++ b/docs/index-files/index-22.html @@ -1,11 +1,11 @@ - + W-Index - + diff --git a/docs/index-files/index-23.html b/docs/index-files/index-23.html index 805c215..9d2fb65 100644 --- a/docs/index-files/index-23.html +++ b/docs/index-files/index-23.html @@ -1,11 +1,11 @@ - + Y-Index - + diff --git a/docs/index-files/index-3.html b/docs/index-files/index-3.html index 30cc740..2b805d6 100644 --- a/docs/index-files/index-3.html +++ b/docs/index-files/index-3.html @@ -1,11 +1,11 @@ - + C-Index - + @@ -103,15 +103,13 @@

C

Used to give information about a command class.
-
CommandExecuteContext - Record Class in me.efekos.simpler.commands
+
CommandExecuteContext - Class in me.efekos.simpler.commands
+
 
+
CommandExecuteContext(CommandSender, List<String>) - Constructor for class me.efekos.simpler.commands.CommandExecuteContext
Creates a new context to use for running CommandExecutives of CommandNodes.
-
CommandExecuteContext(CommandSender, List<String>) - Constructor for record class me.efekos.simpler.commands.CommandExecuteContext
-
-
Creates an instance of a CommandExecuteContext record class.
-
CommandExecutive - Interface in me.efekos.simpler.commands.node
Main interface used by CommandNodes as 'a method to run when someone executes me'.
diff --git a/docs/index-files/index-4.html b/docs/index-files/index-4.html index 5b11563..fde89f8 100644 --- a/docs/index-files/index-4.html +++ b/docs/index-files/index-4.html @@ -1,11 +1,11 @@ - + D-Index - + diff --git a/docs/index-files/index-5.html b/docs/index-files/index-5.html index d8b85a9..82ab163 100644 --- a/docs/index-files/index-5.html +++ b/docs/index-files/index-5.html @@ -1,11 +1,11 @@ - + E-Index - + @@ -65,10 +65,6 @@

E

 
EnchantmentStorageTag(ItemTag, EnchantmentCompound[]) - Constructor for class me.efekos.simpler.items.tag.EnchantmentStorageTag
 
-
equals(Object) - Method in record class me.efekos.simpler.commands.CommandExecuteContext
-
-
Indicates whether some other object is "equal to" this one.
-
execute(CommandSender, String, String[]) - Method in class me.efekos.simpler.commands.BaseCommand
Executes the command, returning its success
diff --git a/docs/index-files/index-6.html b/docs/index-files/index-6.html index 61a490a..912e8fd 100644 --- a/docs/index-files/index-6.html +++ b/docs/index-files/index-6.html @@ -1,11 +1,11 @@ - + F-Index - + diff --git a/docs/index-files/index-7.html b/docs/index-files/index-7.html index 4a18fdf..e3dee70 100644 --- a/docs/index-files/index-7.html +++ b/docs/index-files/index-7.html @@ -1,11 +1,11 @@ - + G-Index - + @@ -79,6 +79,10 @@

G

getAmplifier() - Method in class me.efekos.simpler.items.compound.PotionEffectCompound
 
+
getArgs() - Method in class me.efekos.simpler.commands.CommandExecuteContext
+
+
Returns a list of the arguments that sender gave.
+
getArguments() - Method in class me.efekos.simpler.commands.syntax.Syntax
Returns a list of the Arguments on this syntax.
@@ -413,6 +417,18 @@

G

getRows() - Method in class me.efekos.simpler.menu.PaginatedMenu
 
+
getSender() - Method in class me.efekos.simpler.commands.CommandExecuteContext
+
+
Returns the sender that ran this command.
+
+
getSenderAsConsole() - Method in class me.efekos.simpler.commands.CommandExecuteContext
+
+
Casts the sender to a ConsoleCommandSender, then returns it.
+
+
getSenderAsPlayer() - Method in class me.efekos.simpler.commands.CommandExecuteContext
+
+
Casts the sender to a Player, then returns it.
+
getSkullOwner() - Method in class me.efekos.simpler.items.tag.SkullTag
 
getSlot() - Method in class me.efekos.simpler.items.ItemContent
diff --git a/docs/index-files/index-8.html b/docs/index-files/index-8.html index 9f524d7..715b7b3 100644 --- a/docs/index-files/index-8.html +++ b/docs/index-files/index-8.html @@ -1,11 +1,11 @@ - + H-Index - + @@ -73,10 +73,6 @@

H

Makes sure that the argument player wrote is valid.
-
hashCode() - Method in record class me.efekos.simpler.commands.CommandExecuteContext
-
-
Returns a hash code value for this object.
-
hexColorsPattern - Static variable in class me.efekos.simpler.translation.TranslateManager
The pattern used for detecting hex colors.
diff --git a/docs/index-files/index-9.html b/docs/index-files/index-9.html index 0580843..830e413 100644 --- a/docs/index-files/index-9.html +++ b/docs/index-files/index-9.html @@ -1,11 +1,11 @@ - + I-Index - + @@ -184,11 +184,11 @@

I

Grabs the value of Command.playerOnly() and returns it.
-
isSenderConsole() - Method in record class me.efekos.simpler.commands.CommandExecuteContext
+
isSenderConsole() - Method in class me.efekos.simpler.commands.CommandExecuteContext
Checks what sender is, and returns whether the sender is the console or not.
-
isSenderPlayer() - Method in record class me.efekos.simpler.commands.CommandExecuteContext
+
isSenderPlayer() - Method in class me.efekos.simpler.commands.CommandExecuteContext
Checks what sender is, and returns whether the sender is a player or not.
diff --git a/docs/index.html b/docs/index.html index dc228c5..1921ed9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,11 +1,11 @@ - + Overview - + diff --git a/docs/me/efekos/simpler/Metrics.AdvancedBarChart.html b/docs/me/efekos/simpler/Metrics.AdvancedBarChart.html index c4a3aa7..ce61320 100644 --- a/docs/me/efekos/simpler/Metrics.AdvancedBarChart.html +++ b/docs/me/efekos/simpler/Metrics.AdvancedBarChart.html @@ -1,11 +1,11 @@ - + Metrics.AdvancedBarChart - + diff --git a/docs/me/efekos/simpler/Metrics.AdvancedPie.html b/docs/me/efekos/simpler/Metrics.AdvancedPie.html index 60afd59..3da9fc0 100644 --- a/docs/me/efekos/simpler/Metrics.AdvancedPie.html +++ b/docs/me/efekos/simpler/Metrics.AdvancedPie.html @@ -1,11 +1,11 @@ - + Metrics.AdvancedPie - + diff --git a/docs/me/efekos/simpler/Metrics.CustomChart.html b/docs/me/efekos/simpler/Metrics.CustomChart.html index 795e365..800967f 100644 --- a/docs/me/efekos/simpler/Metrics.CustomChart.html +++ b/docs/me/efekos/simpler/Metrics.CustomChart.html @@ -1,11 +1,11 @@ - + Metrics.CustomChart - + diff --git a/docs/me/efekos/simpler/Metrics.DrilldownPie.html b/docs/me/efekos/simpler/Metrics.DrilldownPie.html index 3c455ab..67a5fd7 100644 --- a/docs/me/efekos/simpler/Metrics.DrilldownPie.html +++ b/docs/me/efekos/simpler/Metrics.DrilldownPie.html @@ -1,11 +1,11 @@ - + Metrics.DrilldownPie - + diff --git a/docs/me/efekos/simpler/Metrics.JsonObjectBuilder.JsonObject.html b/docs/me/efekos/simpler/Metrics.JsonObjectBuilder.JsonObject.html index 36cbf86..8f5c953 100644 --- a/docs/me/efekos/simpler/Metrics.JsonObjectBuilder.JsonObject.html +++ b/docs/me/efekos/simpler/Metrics.JsonObjectBuilder.JsonObject.html @@ -1,11 +1,11 @@ - + Metrics.JsonObjectBuilder.JsonObject - + diff --git a/docs/me/efekos/simpler/Metrics.JsonObjectBuilder.html b/docs/me/efekos/simpler/Metrics.JsonObjectBuilder.html index 98727aa..18a2a63 100644 --- a/docs/me/efekos/simpler/Metrics.JsonObjectBuilder.html +++ b/docs/me/efekos/simpler/Metrics.JsonObjectBuilder.html @@ -1,11 +1,11 @@ - + Metrics.JsonObjectBuilder - + diff --git a/docs/me/efekos/simpler/Metrics.MetricsBase.html b/docs/me/efekos/simpler/Metrics.MetricsBase.html index b9df451..f73044a 100644 --- a/docs/me/efekos/simpler/Metrics.MetricsBase.html +++ b/docs/me/efekos/simpler/Metrics.MetricsBase.html @@ -1,11 +1,11 @@ - + Metrics.MetricsBase - + diff --git a/docs/me/efekos/simpler/Metrics.MultiLineChart.html b/docs/me/efekos/simpler/Metrics.MultiLineChart.html index bb61078..6683f6d 100644 --- a/docs/me/efekos/simpler/Metrics.MultiLineChart.html +++ b/docs/me/efekos/simpler/Metrics.MultiLineChart.html @@ -1,11 +1,11 @@ - + Metrics.MultiLineChart - + diff --git a/docs/me/efekos/simpler/Metrics.SimpleBarChart.html b/docs/me/efekos/simpler/Metrics.SimpleBarChart.html index 6c00378..67e7613 100644 --- a/docs/me/efekos/simpler/Metrics.SimpleBarChart.html +++ b/docs/me/efekos/simpler/Metrics.SimpleBarChart.html @@ -1,11 +1,11 @@ - + Metrics.SimpleBarChart - + diff --git a/docs/me/efekos/simpler/Metrics.SimplePie.html b/docs/me/efekos/simpler/Metrics.SimplePie.html index cd57b2a..84313dd 100644 --- a/docs/me/efekos/simpler/Metrics.SimplePie.html +++ b/docs/me/efekos/simpler/Metrics.SimplePie.html @@ -1,11 +1,11 @@ - + Metrics.SimplePie - + diff --git a/docs/me/efekos/simpler/Metrics.SingleLineChart.html b/docs/me/efekos/simpler/Metrics.SingleLineChart.html index 2727891..44b57d0 100644 --- a/docs/me/efekos/simpler/Metrics.SingleLineChart.html +++ b/docs/me/efekos/simpler/Metrics.SingleLineChart.html @@ -1,11 +1,11 @@ - + Metrics.SingleLineChart - + diff --git a/docs/me/efekos/simpler/Metrics.html b/docs/me/efekos/simpler/Metrics.html index b2422b6..c1dcf6a 100644 --- a/docs/me/efekos/simpler/Metrics.html +++ b/docs/me/efekos/simpler/Metrics.html @@ -1,11 +1,11 @@ - + Metrics - + diff --git a/docs/me/efekos/simpler/Simpler.html b/docs/me/efekos/simpler/Simpler.html index 654d4cd..6372b62 100644 --- a/docs/me/efekos/simpler/Simpler.html +++ b/docs/me/efekos/simpler/Simpler.html @@ -1,11 +1,11 @@ - + Simpler - + diff --git a/docs/me/efekos/simpler/Utilities.html b/docs/me/efekos/simpler/Utilities.html index f43545c..014687d 100644 --- a/docs/me/efekos/simpler/Utilities.html +++ b/docs/me/efekos/simpler/Utilities.html @@ -1,11 +1,11 @@ - + Utilities - + diff --git a/docs/me/efekos/simpler/annotations/Command.html b/docs/me/efekos/simpler/annotations/Command.html index c3c7fbd..037ec6b 100644 --- a/docs/me/efekos/simpler/annotations/Command.html +++ b/docs/me/efekos/simpler/annotations/Command.html @@ -1,11 +1,11 @@ - + Command - + diff --git a/docs/me/efekos/simpler/annotations/LeftClick.html b/docs/me/efekos/simpler/annotations/LeftClick.html index f88336d..b57eac4 100644 --- a/docs/me/efekos/simpler/annotations/LeftClick.html +++ b/docs/me/efekos/simpler/annotations/LeftClick.html @@ -1,11 +1,11 @@ - + LeftClick - + diff --git a/docs/me/efekos/simpler/annotations/Listen.html b/docs/me/efekos/simpler/annotations/Listen.html index 0f2b754..7f88896 100644 --- a/docs/me/efekos/simpler/annotations/Listen.html +++ b/docs/me/efekos/simpler/annotations/Listen.html @@ -1,11 +1,11 @@ - + Listen - + diff --git a/docs/me/efekos/simpler/annotations/RightClick.html b/docs/me/efekos/simpler/annotations/RightClick.html index 1fba5b1..91547e8 100644 --- a/docs/me/efekos/simpler/annotations/RightClick.html +++ b/docs/me/efekos/simpler/annotations/RightClick.html @@ -1,11 +1,11 @@ - + RightClick - + diff --git a/docs/me/efekos/simpler/annotations/package-summary.html b/docs/me/efekos/simpler/annotations/package-summary.html index 5380fbe..e4af8be 100644 --- a/docs/me/efekos/simpler/annotations/package-summary.html +++ b/docs/me/efekos/simpler/annotations/package-summary.html @@ -1,11 +1,11 @@ - + me.efekos.simpler.annotations - + diff --git a/docs/me/efekos/simpler/annotations/package-tree.html b/docs/me/efekos/simpler/annotations/package-tree.html index 7e06f42..38a9de5 100644 --- a/docs/me/efekos/simpler/annotations/package-tree.html +++ b/docs/me/efekos/simpler/annotations/package-tree.html @@ -1,11 +1,11 @@ - + me.efekos.simpler.annotations Class Hierarchy - + diff --git a/docs/me/efekos/simpler/commands/BaseCommand.html b/docs/me/efekos/simpler/commands/BaseCommand.html index c0ce8e5..11636a9 100644 --- a/docs/me/efekos/simpler/commands/BaseCommand.html +++ b/docs/me/efekos/simpler/commands/BaseCommand.html @@ -1,11 +1,11 @@ - + BaseCommand - + diff --git a/docs/me/efekos/simpler/commands/CommandExecuteContext.html b/docs/me/efekos/simpler/commands/CommandExecuteContext.html index fc3cad6..95c61d9 100644 --- a/docs/me/efekos/simpler/commands/CommandExecuteContext.html +++ b/docs/me/efekos/simpler/commands/CommandExecuteContext.html @@ -1,12 +1,12 @@ - + CommandExecuteContext - - + + @@ -88,24 +88,15 @@
Package me.efekos.simpler.commands
-

Record Class CommandExecuteContext

+

Class CommandExecuteContext

java.lang.Object -
java.lang.Record
me.efekos.simpler.commands.CommandExecuteContext
-
-
-
Record Components:
-
sender - Sender that ran this command.
-
args - List of the arguments sender gave.
-
-
public record CommandExecuteContext(org.bukkit.command.CommandSender sender, List<String> args) -extends Record
-
Creates a new context to use for running CommandExecutives of - CommandNodes.
+
public class CommandExecuteContext +extends Object
@@ -137,46 +129,41 @@

Method Summary

Method
Description
List<String>
-
args()
+
getArgs()
-
Returns the value of the args record component.
+
Returns a list of the arguments that sender gave.
-
final boolean
-
equals(Object o)
+
org.bukkit.command.CommandSender
+
getSender()
-
Indicates whether some other object is "equal to" this one.
+
Returns the sender that ran this command.
-
final int
-
hashCode()
+
org.bukkit.command.ConsoleCommandSender
+
getSenderAsConsole()
-
Returns a hash code value for this object.
+
Casts the sender to a ConsoleCommandSender, then returns it.
-
boolean
-
isSenderConsole()
+
org.bukkit.entity.Player
+
getSenderAsPlayer()
-
Checks what sender is, and returns whether the sender is the console or not.
+
Casts the sender to a Player, then returns it.
boolean
-
isSenderPlayer()
+
isSenderConsole()
-
Checks what sender is, and returns whether the sender is a player or not.
+
Checks what sender is, and returns whether the sender is the console or not.
-
org.bukkit.command.CommandSender
-
sender()
+
boolean
+
isSenderPlayer()
-
Returns the value of the sender record component.
-
-
final String
-
toString()
-
-
Returns a string representation of this record class.
+
Checks what sender is, and returns whether the sender is a player or not.

Methods inherited from class java.lang.Object

-getClass, notify, notifyAll, wait, wait, wait
+equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait @@ -193,11 +180,12 @@

Constructor Details

CommandExecuteContext

public CommandExecuteContext(org.bukkit.command.CommandSender sender, List<String> args)
-
Creates an instance of a CommandExecuteContext record class.
+
Creates a new context to use for running CommandExecutives of + CommandNodes.
Parameters:
-
sender - the value for the sender record component
-
args - the value for the args record component
+
sender - Sender that ran this command.
+
args - List of the arguments sender gave.
@@ -232,65 +220,49 @@

isSenderConsole

  • -
    -

    sender

    -
    public org.bukkit.command.CommandSender sender()
    -
    Returns the value of the sender record component.
    +
    +

    getSender

    +
    public org.bukkit.command.CommandSender getSender()
    +
    Returns the sender that ran this command.
    Returns:
    -
    the value of the sender record component
    +
    Sender of this context.
  • -
    -

    args

    -
    public List<String> args()
    -
    Returns the value of the args record component.
    +
    +

    getSenderAsPlayer

    +
    public org.bukkit.entity.Player getSenderAsPlayer()
    +
    Casts the sender to a Player, then returns it. Make sure to use this only when isSenderPlayer() + is true.
    Returns:
    -
    the value of the args record component
    +
    Sender of this context as Player.
  • -
    -

    toString

    -
    public final String toString()
    -
    Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
    +
    +

    getSenderAsConsole

    +
    public org.bukkit.command.ConsoleCommandSender getSenderAsConsole()
    +
    Casts the sender to a ConsoleCommandSender, then returns it. Make sure to use this only when + isSenderConsole() is true.
    -
    Specified by:
    -
    toString in class Record
    Returns:
    -
    a string representation of this object
    +
    Sender of this context as ConsoleCommandSender.
  • -
    -

    hashCode

    -
    public final int hashCode()
    -
    Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
    +
    +

    getArgs

    +
    public List<String> getArgs()
    +
    Returns a list of the arguments that sender gave. Keep in mind that LabelNodes + are filtered out from this list. You'll only get the arguments.
    -
    Specified by:
    -
    hashCode in class Record
    -
    Returns:
    -
    a hash code value for this object
    -
    -
    -
    • -
  • -
    -

    equals

    -
    public final boolean equals(Object o)
    -
    Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
    -
    -
    Specified by:
    -
    equals in class Record
    -
    Parameters:
    -
    o - the object with which to compare
    Returns:
    -
    true if this object is the same as the o argument; false otherwise.
    +
    Argument list of this context.
    • diff --git a/docs/me/efekos/simpler/commands/CommandManager.html b/docs/me/efekos/simpler/commands/CommandManager.html index 15cf098..a7ee7ec 100644 --- a/docs/me/efekos/simpler/commands/CommandManager.html +++ b/docs/me/efekos/simpler/commands/CommandManager.html @@ -1,11 +1,11 @@ - + CommandManager - + diff --git a/docs/me/efekos/simpler/commands/CommandTree.html b/docs/me/efekos/simpler/commands/CommandTree.html index 049d5e5..2a37dd5 100644 --- a/docs/me/efekos/simpler/commands/CommandTree.html +++ b/docs/me/efekos/simpler/commands/CommandTree.html @@ -1,11 +1,11 @@ - + CommandTree - + diff --git a/docs/me/efekos/simpler/commands/CoreCommand.html b/docs/me/efekos/simpler/commands/CoreCommand.html index 3dace72..c4989ae 100644 --- a/docs/me/efekos/simpler/commands/CoreCommand.html +++ b/docs/me/efekos/simpler/commands/CoreCommand.html @@ -1,11 +1,11 @@ - + CoreCommand - + diff --git a/docs/me/efekos/simpler/commands/SubCommand.html b/docs/me/efekos/simpler/commands/SubCommand.html index 187c092..3d44a03 100644 --- a/docs/me/efekos/simpler/commands/SubCommand.html +++ b/docs/me/efekos/simpler/commands/SubCommand.html @@ -1,11 +1,11 @@ - + SubCommand - + diff --git a/docs/me/efekos/simpler/commands/node/ArgumentNode.html b/docs/me/efekos/simpler/commands/node/ArgumentNode.html index d987b60..c1ade5d 100644 --- a/docs/me/efekos/simpler/commands/node/ArgumentNode.html +++ b/docs/me/efekos/simpler/commands/node/ArgumentNode.html @@ -1,11 +1,11 @@ - + ArgumentNode - + diff --git a/docs/me/efekos/simpler/commands/node/CommandExecutive.html b/docs/me/efekos/simpler/commands/node/CommandExecutive.html index 3345b96..d678bd6 100644 --- a/docs/me/efekos/simpler/commands/node/CommandExecutive.html +++ b/docs/me/efekos/simpler/commands/node/CommandExecutive.html @@ -1,11 +1,11 @@ - + CommandExecutive - + diff --git a/docs/me/efekos/simpler/commands/node/CommandNode.html b/docs/me/efekos/simpler/commands/node/CommandNode.html index a1ee392..7a077f8 100644 --- a/docs/me/efekos/simpler/commands/node/CommandNode.html +++ b/docs/me/efekos/simpler/commands/node/CommandNode.html @@ -1,11 +1,11 @@ - + CommandNode - + diff --git a/docs/me/efekos/simpler/commands/node/impl/IntegerArgumentNode.html b/docs/me/efekos/simpler/commands/node/impl/IntegerArgumentNode.html index 189e0b8..27225fc 100644 --- a/docs/me/efekos/simpler/commands/node/impl/IntegerArgumentNode.html +++ b/docs/me/efekos/simpler/commands/node/impl/IntegerArgumentNode.html @@ -1,11 +1,11 @@ - + IntegerArgumentNode - + diff --git a/docs/me/efekos/simpler/commands/node/impl/LabelNode.html b/docs/me/efekos/simpler/commands/node/impl/LabelNode.html index bac6de0..21a324a 100644 --- a/docs/me/efekos/simpler/commands/node/impl/LabelNode.html +++ b/docs/me/efekos/simpler/commands/node/impl/LabelNode.html @@ -1,11 +1,11 @@ - + LabelNode - + diff --git a/docs/me/efekos/simpler/commands/node/impl/ListArgumentNode.html b/docs/me/efekos/simpler/commands/node/impl/ListArgumentNode.html index db8896a..f539a78 100644 --- a/docs/me/efekos/simpler/commands/node/impl/ListArgumentNode.html +++ b/docs/me/efekos/simpler/commands/node/impl/ListArgumentNode.html @@ -1,11 +1,11 @@ - + ListArgumentNode - + diff --git a/docs/me/efekos/simpler/commands/node/impl/PlayerArgumentNode.html b/docs/me/efekos/simpler/commands/node/impl/PlayerArgumentNode.html index fd917ec..45dddd6 100644 --- a/docs/me/efekos/simpler/commands/node/impl/PlayerArgumentNode.html +++ b/docs/me/efekos/simpler/commands/node/impl/PlayerArgumentNode.html @@ -1,11 +1,11 @@ - + PlayerArgumentNode - + diff --git a/docs/me/efekos/simpler/commands/node/impl/StringArgumentNode.html b/docs/me/efekos/simpler/commands/node/impl/StringArgumentNode.html index 97182b7..cdf95a8 100644 --- a/docs/me/efekos/simpler/commands/node/impl/StringArgumentNode.html +++ b/docs/me/efekos/simpler/commands/node/impl/StringArgumentNode.html @@ -1,11 +1,11 @@ - + StringArgumentNode - + diff --git a/docs/me/efekos/simpler/commands/node/impl/package-summary.html b/docs/me/efekos/simpler/commands/node/impl/package-summary.html index 96afec5..c5245cb 100644 --- a/docs/me/efekos/simpler/commands/node/impl/package-summary.html +++ b/docs/me/efekos/simpler/commands/node/impl/package-summary.html @@ -1,11 +1,11 @@ - + me.efekos.simpler.commands.node.impl - + diff --git a/docs/me/efekos/simpler/commands/node/impl/package-tree.html b/docs/me/efekos/simpler/commands/node/impl/package-tree.html index 17a9bd4..ad2fefe 100644 --- a/docs/me/efekos/simpler/commands/node/impl/package-tree.html +++ b/docs/me/efekos/simpler/commands/node/impl/package-tree.html @@ -1,11 +1,11 @@ - + me.efekos.simpler.commands.node.impl Class Hierarchy - + diff --git a/docs/me/efekos/simpler/commands/node/package-summary.html b/docs/me/efekos/simpler/commands/node/package-summary.html index e35e871..67fd0f0 100644 --- a/docs/me/efekos/simpler/commands/node/package-summary.html +++ b/docs/me/efekos/simpler/commands/node/package-summary.html @@ -1,11 +1,11 @@ - + me.efekos.simpler.commands.node - + diff --git a/docs/me/efekos/simpler/commands/node/package-tree.html b/docs/me/efekos/simpler/commands/node/package-tree.html index a6a1335..86a7671 100644 --- a/docs/me/efekos/simpler/commands/node/package-tree.html +++ b/docs/me/efekos/simpler/commands/node/package-tree.html @@ -1,11 +1,11 @@ - + me.efekos.simpler.commands.node Class Hierarchy - + diff --git a/docs/me/efekos/simpler/commands/package-summary.html b/docs/me/efekos/simpler/commands/package-summary.html index 9aec4e6..88c4052 100644 --- a/docs/me/efekos/simpler/commands/package-summary.html +++ b/docs/me/efekos/simpler/commands/package-summary.html @@ -1,11 +1,11 @@ - + me.efekos.simpler.commands - + @@ -16,11 +16,7 @@ -