Repo-Mirror/HMCCosmetics
9
0
Fork 0
mirror of https://github.com/HibiscusMC/HMCCosmetics.git synced 2025-12-19 15:09:19 +00:00
Code Issues Releases Activity

docs(CosmeticUserProvider): add nullability annotations for methods

Browse Source
This commit is contained in:
Craftinators
2025-01-23 12:10:34 -05:00
parent e7fd39a077
commit ab614d8b07
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
common/src/main/java/com/hibiscusmc/hmccosmetics/user/CosmeticUserProvider.java
View File

@@ -4,6 +4,7 @@ import com.hibiscusmc.hmccosmetics.HMCCosmeticsPlugin;
import com.hibiscusmc.hmccosmetics.database.UserData;
import org.bukkit.event.player.PlayerJoinEvent;
import org.bukkit.plugin.Plugin;
import org.jetbrains.annotations.NotNull;
import java.util.UUID;
@@ -20,7 +21,7 @@ public interface CosmeticUserProvider {
* @return the {@link CosmeticUser}
* @apiNote This method is called during the {@link PlayerJoinEvent}.
*/
CosmeticUser createCosmeticUser(UUID playerId, UserData userData);
@NotNull CosmeticUser createCosmeticUser(@NotNull UUID playerId, @NotNull UserData userData);
/**
* Construct the custom {@link CosmeticUser}.
@@ -28,7 +29,7 @@ public interface CosmeticUserProvider {
* @return the {@link CosmeticUser}
* @apiNote This method is called during the {@link PlayerJoinEvent}.
*/
CosmeticUser createCosmeticUserWithoutData(UUID playerId);
@NotNull CosmeticUser createCosmeticUserWithoutData(@NotNull UUID playerId);
/**
* Represents the plugin that is providing this {@link CosmeticUserProvider}
@@ -41,12 +42,12 @@ public interface CosmeticUserProvider {
*/
class Default implements CosmeticUserProvider {
@Override
public CosmeticUser createCosmeticUser(UUID playerId, UserData userData) {
public @NotNull CosmeticUser createCosmeticUser(@NotNull UUID playerId, @NotNull UserData userData) {
return new CosmeticUser(playerId, userData);
}
@Override
public CosmeticUser createCosmeticUserWithoutData(UUID playerId) {
public @NotNull CosmeticUser createCosmeticUserWithoutData(@NotNull UUID playerId) {
return new CosmeticUser(playerId);
}