Package dev.oumaimaa.kawaiiapi.menu

Class PlayerMenuUtility

java.lang.Object

dev.oumaimaa.kawaiiapi.menu.PlayerMenuUtility

public final class PlayerMenuUtility
extends Object

Companion class for storing player-specific menu data. Each player has exactly one PlayerMenuUtility instance that persists across menu navigation's.

This class provides:

• Menu history tracking for back navigation
• Arbitrary data storage per player
• Type-safe data retrieval

Data stored in this utility persists until the player disconnects or the MenuManager is cleared.

Version:

1.0

Author:

KawaiiDevelopment

Method Summary

Modifier and Type	Method	Description
void	clearData()	Clears all stored data.
void	clearMenuHistory()	Clears the menu history stack.
@Nullable Object	getData(@NotNull Enum<?> identifier)	Retrieves data stored under the specified enum key.
<T> T	getData(@NotNull Enum<?> identifier, @NotNull Class<T> classRef)	Retrieves data with automatic type casting using an enum key.
@Nullable Object	getData(@NotNull String identifier)	Retrieves data stored under the specified key.
<T> T	getData(@NotNull String identifier, @NotNull Class<T> classRef)	Retrieves data with automatic type casting.
@NotNull @UnmodifiableView Set<String>	getDataKeys()	Gets all stored data keys.
int	getDataSize()	Gets the number of data entries stored.
int	getMenuHistorySize()	Gets the current size of the menu history stack.
@Nullable org.bukkit.entity.Player	getOwner()	Gets the player who owns this utility.
@NotNull UUID	getOwnerUUID()	Gets the UUID of the player who owns this utility.
boolean	hasData(@NotNull Enum<?> identifier)	Checks if data exists for the specified enum key.
boolean	hasData(@NotNull String identifier)	Checks if data exists for the specified key.
boolean	hasPreviousMenu()	Checks if there is a previous menu in the history.
@Nullable Menu	peekPreviousMenu()	Peeks at the previous menu without removing it from history.
@Nullable Object	removeData(@NotNull Enum<?> identifier)	Removes data associated with the specified enum key.
@Nullable Object	removeData(@NotNull String identifier)	Removes data associated with the specified key.
void	setData(@NotNull Enum<?> identifier, @Nullable Object data)	Stores arbitrary data associated with an enum key.
void	setData(@NotNull String identifier, @Nullable Object data)	Stores arbitrary data associated with a string key.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getOwner

@Nullable
public @Nullable org.bukkit.entity.Player getOwner()

Gets the player who owns this utility.

Returns:

The player instance, or null if they are offline

getOwnerUUID

@NotNull
public @NotNull UUID getOwnerUUID()

Gets the UUID of the player who owns this utility.

Returns:

The player's UUID

setData

public void setData(@NotNull
 @NotNull String identifier,
 @Nullable
 @Nullable Object data)

Stores arbitrary data associated with a string key. Overwrites any existing data with the same key.

Parameters:

identifier - The key to store the data under

data - The data to store (can be any object)

setData

public void setData(@NotNull
 @NotNull Enum<?> identifier,
 @Nullable
 @Nullable Object data)

Stores arbitrary data associated with an enum key. Useful for type-safe key management.

Parameters:

identifier - The enum key to store the data under

data - The data to store

getData

@Nullable
public @Nullable Object getData(@NotNull
 @NotNull String identifier)

Retrieves data stored under the specified key.

Parameters:

identifier - The key to retrieve data for

Returns:

The stored data, or null if not found

getData

@Nullable
public @Nullable Object getData(@NotNull
 @NotNull Enum<?> identifier)

Retrieves data stored under the specified enum key.

Parameters:

identifier - The enum key to retrieve data for

Returns:

The stored data, or null if not found

getData

@Nullable
public <T> T getData(@NotNull
 @NotNull String identifier,
 @NotNull
 @NotNull Class<T> classRef)

Retrieves data with automatic type casting. Returns null if the data doesn't exist or cannot be cast to the specified type.

Type Parameters:

T - The type to cast to

Parameters:

identifier - The key to retrieve data for

classRef - The class to cast the data to

Returns:

The cast data, or null if not found or cast failed

getData

@Nullable
public <T> T getData(@NotNull
 @NotNull Enum<?> identifier,
 @NotNull
 @NotNull Class<T> classRef)

Retrieves data with automatic type casting using an enum key.

Type Parameters:

T - The type to cast to

Parameters:

identifier - The enum key to retrieve data for

classRef - The class to cast the data to

Returns:

The cast data, or null if not found or cast failed

hasData

public boolean hasData(@NotNull
 @NotNull String identifier)

Checks if data exists for the specified key.

Parameters:

identifier - The key to check

Returns:

true if data exists for this key

hasData

public boolean hasData(@NotNull
 @NotNull Enum<?> identifier)

Checks if data exists for the specified enum key.

Parameters:

identifier - The enum key to check

Returns:

true if data exists for this key

removeData

@Nullable
public @Nullable Object removeData(@NotNull
 @NotNull String identifier)

Removes data associated with the specified key.

Parameters:

identifier - The key to remove

Returns:

The removed data, or null if not found

removeData

@Nullable
public @Nullable Object removeData(@NotNull
 @NotNull Enum<?> identifier)

Removes data associated with the specified enum key.

Parameters:

identifier - The enum key to remove

Returns:

The removed data, or null if not found

clearData

public void clearData()

Clears all stored data. Does not affect menu history.

getDataSize

public int getDataSize()

Gets the number of data entries stored.

Returns:

The data map size

getMenuHistorySize

public int getMenuHistorySize()

Gets the current size of the menu history stack.

Returns:

The number of menus in history

clearMenuHistory

public void clearMenuHistory()

Clears the menu history stack. Useful when you want to prevent back navigation.

hasPreviousMenu

public boolean hasPreviousMenu()

Checks if there is a previous menu in the history.

Returns:

true if back navigation is possible

peekPreviousMenu

@Nullable
public @Nullable Menu peekPreviousMenu()

Peeks at the previous menu without removing it from history.

Returns:

The previous menu, or null if none exists

getDataKeys

@NotNull
public @NotNull @UnmodifiableView Set<String> getDataKeys()

Gets all stored data keys.

Returns:

Set of all data keys

toString

public String toString()

Overrides:

toString in class Object