Skip to content

Commit df6fbc2

Browse files
dkim19375dkim19375
committed
Add annotations and more methods in PlayerUtils
1 parent 3cae9a9 commit df6fbc2

File tree

6 files changed

+71
-30
lines changed

6 files changed

+71
-30
lines changed

‎src/main/java/me/dkim19375/dkim19375core/PlayerUtils.java‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
import org.bukkit.Bukkit;
44
import org.bukkit.entity.Player;
5+
import org.jetbrains.annotations.NotNull;
6+
import org.jetbrains.annotations.Nullable;
57

68
import java.util.UUID;
79

@@ -12,6 +14,8 @@ private PlayerUtils() {
1214
public enum InputTypes {
1315
VALID_USERNAME, VALID_UUID, INVALID_USERNAME, INVALID_UUID, INVALID
1416
}
17+
18+
@Nullable
1519
public static Player getFromAll(final String uuidOrPlayer) {
1620
if (uuidOrPlayer.matches("^\\w{3,16}$")) {
1721
return Bukkit.getPlayer(uuidOrPlayer);
@@ -23,10 +27,12 @@ public static Player getFromAll(final String uuidOrPlayer) {
2327
return null;
2428
}
2529

30+
@Nullable
2631
public static Player getFromAll(final UUID uuid) {
2732
return Bukkit.getPlayer(uuid);
2833
}
2934

35+
@NotNull
3036
public static InputTypes getInputType(final String uuidOrPlayer) {
3137
if (uuidOrPlayer.matches("^\\w{3,16}$")) {
3238
final Player player = Bukkit.getPlayer(uuidOrPlayer);
@@ -48,18 +54,21 @@ public static InputTypes getInputType(final String uuidOrPlayer) {
4854
return InputTypes.INVALID;
4955
}
5056

57+
@Nullable
5158
public static Player getPlayerFromUsername(final String username) {
5259
if (username.matches("^\\w{3,16}$")) {
5360
return Bukkit.getPlayer(username);
5461
}
5562
return null;
5663
}
5764

65+
@Nullable
5866
public static Player getPlayerFromUUID(final String StringUUID) {
5967
final UUID uuid = UUID.fromString(StringUUID);
6068
return Bukkit.getPlayer(uuid);
6169
}
6270

71+
@Nullable
6372
public static Player getPlayerFromUUID(final UUID uuid) {
6473
return Bukkit.getPlayer(uuid);
6574
}

‎src/main/java/me/dkim19375/dkim19375core/external/FormattingUtils.java‎

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,45 @@
33
import me.clip.placeholderapi.PlaceholderAPI;
44
import org.bukkit.ChatColor;
55
import org.bukkit.entity.Player;
6+
import org.jetbrains.annotations.NotNull;
67

78
public class FormattingUtils {
89
private FormattingUtils() {
9-
1010
}
11-
public static String formatWithPAPIAndColors(final Player player, final String string) {
11+
12+
@NotNull
13+
public static String formatWithPAPIAndColors(final @NotNull Player player, final @NotNull String string) {
1214
String parsed;
1315
parsed = PlaceholderAPI.setPlaceholders(player, string);
1416
parsed = ChatColor.translateAlternateColorCodes('&', parsed);
1517
return parsed;
1618
}
1719

18-
public static String formatWithPAPIAndColors(final Player player, final String string, final char altColorChar) {
20+
@NotNull
21+
public static String formatWithPAPIAndColors(final @NotNull Player player, final @NotNull String string, final char altColorChar) {
1922
String parsed;
2023
parsed = PlaceholderAPI.setPlaceholders(player, string);
2124
parsed = ChatColor.translateAlternateColorCodes(altColorChar, parsed);
2225
return parsed;
2326
}
2427

25-
public static String formatWithColors(final String string) {
28+
@NotNull
29+
public static String formatWithColors(final @NotNull String string) {
2630
return ChatColor.translateAlternateColorCodes('&', string);
2731
}
2832

29-
public static String formatWithColors(final String string, final char altColorChar) {
33+
@NotNull
34+
public static String formatWithColors(final @NotNull String string, final char altColorChar) {
3035
return ChatColor.translateAlternateColorCodes(altColorChar, string);
3136
}
37+
38+
@NotNull
39+
public static String formatWithPAPI(final @NotNull String string) {
40+
return PlaceholderAPI.setPlaceholders(null, string);
41+
}
42+
43+
@NotNull
44+
public static String formatWithPAPI(final @NotNull Player player, final @NotNull String string) {
45+
return PlaceholderAPI.setPlaceholders(player, string);
46+
}
3247
}

‎src/main/java/me/dkim19375/dkim19375core/external/JsonUtils.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
import org.bukkit.Bukkit;
88
import org.bukkit.plugin.java.JavaPlugin;
99
import org.bukkit.util.Consumer;
10+
import org.jetbrains.annotations.NotNull;
1011

1112
import java.io.IOException;
1213
import java.io.InputStream;
@@ -17,7 +18,7 @@ private JsonUtils() {
1718

1819
}
1920

20-
public static void getJson(final Consumer<JsonObject> consumer, final Consumer<IOException> exception, URL url, JavaPlugin plugin) {
21+
public static void getJson(final @NotNull Consumer<JsonObject> consumer, final @NotNull Consumer<IOException> exception, final @NotNull URL url, final @NotNull JavaPlugin plugin) {
2122
Bukkit.getScheduler().runTaskAsynchronously(plugin, () -> {
2223
String string;
2324
try {
@@ -36,7 +37,7 @@ public static void getJson(final Consumer<JsonObject> consumer, final Consumer<I
3637
});
3738
}
3839

39-
public static void getJson(final Consumer<JsonObject> consumer, final Consumer<IOException> exception, String url, JavaPlugin plugin) {
40+
public static void getJson(final @NotNull Consumer<JsonObject> consumer, final @NotNull Consumer<IOException> exception, final @NotNull String url, final @NotNull JavaPlugin plugin) {
4041
Bukkit.getScheduler().runTaskAsynchronously(plugin, () -> {
4142
String string;
4243
try {

‎src/main/java/me/dkim19375/dkim19375core/external/PAPIExpansion.java‎

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
package me.dkim19375.dkim19375core.external;
22

33
import me.clip.placeholderapi.expansion.PlaceholderExpansion;
4+
import org.bukkit.OfflinePlayer;
45
import org.bukkit.entity.Player;
56
import org.bukkit.plugin.java.JavaPlugin;
7+
import org.jetbrains.annotations.NotNull;
8+
import org.jetbrains.annotations.Nullable;
69

7-
import javax.annotation.Nullable;
8-
9-
public abstract class PAPIExpansion extends PlaceholderExpansion {
10+
public class PAPIExpansion extends PlaceholderExpansion {
1011
private final String identifier;
1112
private final String authors;
1213
private final String version;
1314

14-
public PAPIExpansion(final JavaPlugin plugin, final @Nullable String identifier, final @Nullable String authors, final @Nullable String version) {
15+
public PAPIExpansion(final @NotNull JavaPlugin plugin, final @Nullable String identifier, final @Nullable String authors, final @Nullable String version) {
1516
if (identifier == null) {
1617
this.identifier = plugin.getDescription().getName();
1718
} else {
@@ -39,24 +40,33 @@ public boolean canRegister() {
3940
return true;
4041
}
4142

42-
@SuppressWarnings("NullableProblems")
4343
@Override
44+
@NotNull
4445
public String getAuthor() {
4546
return authors;
4647
}
4748

48-
@SuppressWarnings("NullableProblems")
4949
@Override
50+
@NotNull
5051
public String getIdentifier() {
5152
return identifier;
5253
}
5354

54-
@SuppressWarnings("NullableProblems")
5555
@Override
56+
@NotNull
5657
public String getVersion() {
5758
return version;
5859
}
5960

6061
@Override
61-
public abstract String onPlaceholderRequest(final Player player, final @Nullable String identifier);
62+
@Nullable
63+
public String onPlaceholderRequest(final Player player, final @Nullable String identifier) {
64+
return null;
65+
}
66+
67+
@Override
68+
@Nullable
69+
public String onRequest(OfflinePlayer player, @NotNull String params) {
70+
return null;
71+
}
6272
}

‎src/main/java/me/dkim19375/dkim19375core/external/UpdateChecker.java‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
import org.bukkit.Bukkit;
55
import org.bukkit.plugin.java.JavaPlugin;
66
import org.bukkit.util.Consumer;
7+
import org.jetbrains.annotations.NotNull;
78

89
import java.io.IOException;
910
import java.io.InputStream;
@@ -16,25 +17,25 @@ public class UpdateChecker {
1617
private final URL url;
1718
private final JavaPlugin plugin;
1819

19-
public UpdateChecker(final String resourceId, final URL url, final JavaPlugin plugin) {
20+
public UpdateChecker(final @NotNull String resourceId, final @NotNull URL url, final @NotNull JavaPlugin plugin) {
2021
this.resourceId = resourceId;
2122
this.url = url;
2223
this.plugin = plugin;
2324
}
2425

25-
public UpdateChecker(final String resourceId, final JavaPlugin plugin) {
26+
public UpdateChecker(final @NotNull String resourceId, final @NotNull JavaPlugin plugin) {
2627
this.resourceId = resourceId;
2728
url = null;
2829
this.plugin = plugin;
2930
}
3031

31-
public UpdateChecker(final URL url, final JavaPlugin plugin) {
32+
public UpdateChecker(final @NotNull URL url, final @NotNull JavaPlugin plugin) {
3233
resourceId = null;
3334
this.url = url;
3435
this.plugin = plugin;
3536
}
3637

37-
public void getSpigotVersion(final Consumer<String> version, final Consumer<IOException> exception) {
38+
public void getSpigotVersion(final @NotNull Consumer<String> version, final @NotNull Consumer<IOException> exception) {
3839
Bukkit.getScheduler().runTaskAsynchronously(this.plugin, () -> {
3940
try (InputStream inputStream = new URL("https://api.spigotmc.org/legacy/update.php?resource=" + this.resourceId).openStream();
4041
Scanner scanner = new Scanner(inputStream)) {
@@ -46,7 +47,7 @@ public void getSpigotVersion(final Consumer<String> version, final Consumer<IOEx
4647
}
4748
});
4849
}
49-
public void getFromRaw(final Consumer<String> version, final Consumer<IOException> exception) {
50+
public void getFromRaw(final @NotNull Consumer<String> version, final @NotNull Consumer<IOException> exception) {
5051
Bukkit.getScheduler().runTaskAsynchronously(this.plugin, () -> {
5152
try (InputStream inputStream = url.openStream();
5253
Scanner scanner = new Scanner(inputStream)) {
@@ -59,7 +60,7 @@ public void getFromRaw(final Consumer<String> version, final Consumer<IOExceptio
5960
});
6061
}
6162

62-
public void getFromGithubJson(final Consumer<String> version, final Consumer<IOException> exception) {
63+
public void getFromGithubJson(final @NotNull Consumer<String> version, final @NotNull Consumer<IOException> exception) {
6364
JsonUtils.getJson((j) -> {
6465
JsonElement element = j.get("tag_name");
6566
String tag = element.getAsString();

‎src/main/java/me/dkim19375/dkim19375core/external/WorldGuardUtils.java‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,30 +13,35 @@
1313
import org.bukkit.Location;
1414
import org.bukkit.entity.Player;
1515
import org.bukkit.util.Consumer;
16+
import org.jetbrains.annotations.NotNull;
17+
import org.jetbrains.annotations.Nullable;
1618

1719
public class WorldGuardUtils {
1820

19-
public static LocalPlayer getLocalPlayerFromBukkitPlayer(final Player player) {
21+
@NotNull
22+
public static LocalPlayer getLocalPlayerFromBukkitPlayer(final @NotNull Player player) {
2023
return WorldGuardPlugin.inst().wrapPlayer(player);
2124
}
2225

23-
public static BlockVector3 getBlockVector3FromLocation(final Location location) {
26+
@NotNull
27+
public static BlockVector3 getBlockVector3FromLocation(final @NotNull Location location) {
2428
return BlockVector3.at(location.getX(), location.getY(), location.getZ());
2529
}
2630

27-
public static BlockVector3 getBlockVector3FromLocation(final com.sk89q.worldedit.util.Location location) {
31+
@NotNull
32+
public static BlockVector3 getBlockVector3FromLocation(final @NotNull com.sk89q.worldedit.util.Location location) {
2833
return BlockVector3.at(location.getX(), location.getY(), location.getZ());
2934
}
3035

31-
32-
public static World getWorldGuardWorldFromBukkitWorld(final org.bukkit.World world) {
36+
@NotNull
37+
public static World getWorldGuardWorldFromBukkitWorld(final @NotNull org.bukkit.World world) {
3338
return BukkitAdapter.adapt(world);
3439
}
3540

3641
/**
3742
* @deprecated Use {@link WorldGuardUtils#testStateOfFlag(Player, StateFlag, Runnable)}
3843
*/
39-
public static boolean testStateOfFlag(final Player player, final StateFlag flag, Consumer<RegionManager> nullRegion) {
44+
public static boolean testStateOfFlag(final @NotNull Player player, final @NotNull StateFlag flag, final @NotNull Consumer<RegionManager> nullRegion) {
4045
RegionContainer c = WorldGuard.getInstance().getPlatform().getRegionContainer();
4146
World world = getWorldGuardWorldFromBukkitWorld(player.getWorld());
4247
RegionManager regions = c.get(world);
@@ -50,7 +55,7 @@ public static boolean testStateOfFlag(final Player player, final StateFlag flag,
5055
return set.testState(lp, flag);
5156
}
5257

53-
public static boolean testStateOfFlag(final Player player, final StateFlag flag, Runnable nullRegion) {
58+
public static boolean testStateOfFlag(final @NotNull Player player, final @NotNull StateFlag flag, final @NotNull Runnable nullRegion) {
5459
RegionContainer c = WorldGuard.getInstance().getPlatform().getRegionContainer();
5560
World world = getWorldGuardWorldFromBukkitWorld(player.getWorld());
5661
RegionManager regions = c.get(world);
@@ -67,7 +72,7 @@ public static boolean testStateOfFlag(final Player player, final StateFlag flag,
6772
/**
6873
* @deprecated Use {@link WorldGuardUtils#testStateOfFlag(Player, Location, StateFlag, Runnable)}
6974
*/
70-
public static boolean testStateOfFlag(Player player, Location location, StateFlag flag, Consumer<RegionManager> nullRegion) {
75+
public static boolean testStateOfFlag(final @NotNull Player player, final @NotNull Location location, final @NotNull StateFlag flag, final @NotNull Consumer<RegionManager> nullRegion) {
7176
RegionContainer c = WorldGuard.getInstance().getPlatform().getRegionContainer();
7277
World world = getWorldGuardWorldFromBukkitWorld(location.getWorld());
7378
RegionManager regions = c.get(world);
@@ -81,7 +86,7 @@ public static boolean testStateOfFlag(Player player, Location location, StateFla
8186
return set.testState(lp, flag);
8287
}
8388

84-
public static boolean testStateOfFlag(Player player, Location location, StateFlag flag, Runnable nullRegion) {
89+
public static boolean testStateOfFlag(final @NotNull Player player, final @NotNull Location location, final @NotNull StateFlag flag, final @NotNull Runnable nullRegion) {
8590
RegionContainer c = WorldGuard.getInstance().getPlatform().getRegionContainer();
8691
World world = getWorldGuardWorldFromBukkitWorld(location.getWorld());
8792
RegionManager regions = c.get(world);

0 commit comments

Comments
 (0)