For more information about the default formatting + * PlayerStats uses, see the class description of * StatResult. * @see StatResult diff --git a/src/main/java/com/github/artemis/the/gr8/playerstats/api/PlayerStats.java b/src/main/java/com/github/artemis/the/gr8/playerstats/api/PlayerStats.java index 3d5bf1a..3a34c04 100644 --- a/src/main/java/com/github/artemis/the/gr8/playerstats/api/PlayerStats.java +++ b/src/main/java/com/github/artemis/the/gr8/playerstats/api/PlayerStats.java @@ -5,8 +5,10 @@ import com.github.artemis.the.gr8.playerstats.statistic.request.StatRequest; import org.jetbrains.annotations.Contract; import org.jetbrains.annotations.NotNull; -/** The outgoing API that you can use to access the core functionality of PlayerStats! - * To work with the API, you need to call PlayerStats.{@link #getAPI()} to get an instance of +/** + * The outgoing API that represents the core functionality of PlayerStats! + * + *
To work with it, you'll need to call PlayerStats.{@link #getAPI()} to get an instance of * {@link PlayerStatsAPI}. You can then use this object to access any of the further methods. * * Since calculating a top or server statistics can take some time, I strongly diff --git a/src/main/java/com/github/artemis/the/gr8/playerstats/api/RequestGenerator.java b/src/main/java/com/github/artemis/the/gr8/playerstats/api/RequestGenerator.java index 4ea376d..865fe50 100644 --- a/src/main/java/com/github/artemis/the/gr8/playerstats/api/RequestGenerator.java +++ b/src/main/java/com/github/artemis/the/gr8/playerstats/api/RequestGenerator.java @@ -7,7 +7,7 @@ import org.bukkit.Statistic; import org.bukkit.entity.EntityType; import org.jetbrains.annotations.NotNull; -/** Is responsible for creating an executable {@link StatRequest}. This Request holds all +/** Creates an executable {@link StatRequest}. This Request holds all * the information PlayerStats needs to work with, and is used by the {@link StatCalculator} * to get the desired statistic data.*/ public interface RequestGenerator { diff --git a/src/main/java/com/github/artemis/the/gr8/playerstats/api/StatManager.java b/src/main/java/com/github/artemis/the/gr8/playerstats/api/StatManager.java index f559448..56dd71a 100644 --- a/src/main/java/com/github/artemis/the/gr8/playerstats/api/StatManager.java +++ b/src/main/java/com/github/artemis/the/gr8/playerstats/api/StatManager.java @@ -1,7 +1,11 @@ package com.github.artemis.the.gr8.playerstats.api; +import com.github.artemis.the.gr8.playerstats.statistic.request.StatRequest; import java.util.LinkedHashMap; +/** + * Turns user input into a {@link StatRequest} that can be used to get statistic data + */ public interface StatManager { /** Gets a RequestGenerator that can be used to create a PlayerStatRequest. @@ -34,4 +38,4 @@ public interface StatManager { * * @return the RequestGenerator*/ RequestGenerator> totalTopStatRequest(); -} +} \ No newline at end of file diff --git a/src/main/java/com/github/artemis/the/gr8/playerstats/api/package-info.java b/src/main/java/com/github/artemis/the/gr8/playerstats/api/package-info.java new file mode 100644 index 0000000..47869c3 --- /dev/null +++ b/src/main/java/com/github/artemis/the/gr8/playerstats/api/package-info.java @@ -0,0 +1,4 @@ +/** + * The PlayerStats API + */ +package com.github.artemis.the.gr8.playerstats.api; diff --git a/src/main/java/com/github/artemis/the/gr8/playerstats/listeners/JoinListener.java b/src/main/java/com/github/artemis/the/gr8/playerstats/listeners/JoinListener.java index acbaaa5..371dbac 100644 --- a/src/main/java/com/github/artemis/the/gr8/playerstats/listeners/JoinListener.java +++ b/src/main/java/com/github/artemis/the/gr8/playerstats/listeners/JoinListener.java @@ -4,10 +4,13 @@ import com.github.artemis.the.gr8.playerstats.ThreadManager; import org.bukkit.event.EventHandler; import org.bukkit.event.Listener; import org.bukkit.event.player.PlayerJoinEvent; +import org.jetbrains.annotations.ApiStatus; -/** Listens for new Players that join, and reloads PlayerStats +/** + * Listens for new Players that join, and reloads PlayerStats * if someone joins that hasn't joined before. */ +@ApiStatus.Internal public class JoinListener implements Listener { private static ThreadManager threadManager; diff --git a/src/main/java/com/github/artemis/the/gr8/playerstats/msg/msgutils/LanguageKeyHandler.java b/src/main/java/com/github/artemis/the/gr8/playerstats/msg/msgutils/LanguageKeyHandler.java index 90db036..49884b5 100644 --- a/src/main/java/com/github/artemis/the/gr8/playerstats/msg/msgutils/LanguageKeyHandler.java +++ b/src/main/java/com/github/artemis/the/gr8/playerstats/msg/msgutils/LanguageKeyHandler.java @@ -11,6 +11,7 @@ import org.bukkit.configuration.file.YamlConfiguration; import org.bukkit.entity.EntityType; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; +import org.jetbrains.annotations.ApiStatus.Internal; import java.io.File; import java.util.Arrays; @@ -28,6 +29,9 @@ public final class LanguageKeyHandler { private static File languageKeyFile; private static FileConfiguration languageKeys; + /** + * @param plugin an instance of PlayerStats' Main class + */ public LanguageKeyHandler(Main plugin) { LanguageKeyHandler.plugin = plugin; statNameKeys = generateStatNameKeys(); @@ -42,6 +46,7 @@ public final class LanguageKeyHandler { languageKeys = YamlConfiguration.loadConfiguration(languageKeyFile); } + @Internal public static void reloadFile() { if (!languageKeyFile.exists()) { loadFile(); @@ -54,6 +59,9 @@ public final class LanguageKeyHandler { /** * Checks if a given Key is the language key "stat_type.minecraft.killed" * or "commands.kill.success.single" (which results in "Killed %s"). + * + * @param statKey the Key to check + * @return true if this Key is key for kill-entity */ public static boolean isKeyForKillEntity(String statKey) { return statKey.equalsIgnoreCase("stat_type.minecraft.killed") || @@ -72,6 +80,9 @@ public final class LanguageKeyHandler { /** * Checks if a given Key is the language key "stat_type.minecraft.killed_by" * or "stat.minecraft.deaths" (which results in "Number of Deaths"). + * + * @param statKey the Key to check + * @return true if this Key is a key for entity-killed-by */ public static boolean isKeyForEntityKilledBy(String statKey) { return statKey.equalsIgnoreCase("stat_type.minecraft.killed_by") || @@ -91,6 +102,9 @@ public final class LanguageKeyHandler { /** * Checks if a given Key is the language key "book.byAuthor" * (which results in "by %s"). + * + * @param statKey the Key to Check + * @return true if this Key is the key for book.byAuthor */ public static boolean isKeyForEntityKilledByArg(String statKey) { return statKey.equalsIgnoreCase("book.byAuthor"); @@ -106,6 +120,10 @@ public final class LanguageKeyHandler { return "book.byAuthor"; } + /** + * @param key the String to turn into a normal name + * @return a pretty name + */ public static String convertToName(String key) { if (key.equalsIgnoreCase("soundCategory.block")) { return Unit.BLOCK.getLabel(); @@ -154,6 +172,11 @@ public final class LanguageKeyHandler { return languageKeys.getString(realKey); } + /** + * @param statistic the Statistic to get the Key for + * @return the official Key from the NameSpacedKey for this Statistic, + * or return null if no enum constant can be retrieved. + */ public String getStatKey(@NotNull Statistic statistic) { if (statistic.getType() == Statistic.Type.UNTYPED) { return "stat.minecraft." + statNameKeys.get(statistic); @@ -164,8 +187,9 @@ public final class LanguageKeyHandler { } /** - * Get the official Key from the NameSpacedKey for this entityType, - * or return null if no enum constant can be retrieved or entityType is UNKNOWN. + * @param entity the EntityType to get the Key for + * @return the official Key from the NameSpacedKey for this EntityType, + * or return null if no enum constant can be retrieved or EntityType is UNKNOWN. */ public @Nullable String getEntityKey(EntityType entity) { if (entity == null || entity == EntityType.UNKNOWN) return null; @@ -175,7 +199,8 @@ public final class LanguageKeyHandler { } /** - * Get the official Key from the NameSpacedKey for this item Material, + * @param item the Material to get the Key for + * @return the official Key from the NameSpacedKey for this item Material, * or return null if no enum constant can be retrieved. */ public @Nullable String getItemKey(Material item) { @@ -189,7 +214,8 @@ public final class LanguageKeyHandler { } /** - * Returns the official Key from the NameSpacedKey for the block Material provided, + * @param block the Material to get the Key for + * @return the official Key from the NameSpacedKey for the block Material provided, * or return null if no enum constant can be retrieved. */ public @Nullable String getBlockKey(Material block) { @@ -204,6 +230,10 @@ public final class LanguageKeyHandler { } } + /** + * @param unit the Unit to get the Key for + * @return "soundCategory.block" for Unit.Block, null otherwise + */ public @Nullable String getUnitKey(Unit unit) { if (unit == Unit.BLOCK) { return "soundCategory.block";