Package dev.selena.luacore.utils.data

Class UserDataManager

java.lang.Object

dev.selena.luacore.utils.data.UserDataManager

public class UserDataManager
extends Object

Used for internal handling of player data

Field Summary

Fields

Modifier and Type	Field	Description
static String	folderName	The folder that the user data is stored in

Constructor Summary

Constructors

Constructor	Description
UserDataManager(String baseFolder)	Used for setting up the manager class.

Method Summary

Modifier and Type	Method	Description
String	getRelativeUserFolderPath(@NotNull UUID uuid)	Used for getting the path inside your plugin data folder excluding /plugins/PLUGIN/
<T> T	getUserDataFolder(Class<T> userFolderClass, UUID uuid)	Used for getting the initialized data folder class
String	getUserFolderPath(@NotNull UUID uuid)	Used for getting the users data path as a string.
void	saveAllUserData()	Used for saving all users data
void	saveUserData(UserFolder folder)	Used for saving the users data

Methods inherited from class java.lang.Object

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

Field Details

folderName

public static String folderName

The folder that the user data is stored in

Constructor Details

UserDataManager

@Beta
public UserDataManager(String baseFolder)

Used for setting up the manager class.

Parameters:

baseFolder - The base folder for user data to be stored in

Method Details

getUserFolderPath

@Beta
public String getUserFolderPath(@NotNull
 @NotNull UUID uuid)

Used for getting the users data path as a string.

Parameters:

uuid - The users UUID

Returns:

The folder path

getRelativeUserFolderPath

public String getRelativeUserFolderPath(@NotNull
 @NotNull UUID uuid)

Used for getting the path inside your plugin data folder excluding /plugins/PLUGIN/

Parameters:

uuid - the players UUID

Returns:

the relative folder path

getUserDataFolder

@Beta
public <T> T getUserDataFolder(Class<T> userFolderClass,
 UUID uuid)
                        throws NoSuchMethodException,
InvocationTargetException,
InstantiationException,
IllegalAccessException,
NoUserJsonFoundException

Used for getting the initialized data folder class

Type Parameters:

T - The type of the class

Parameters:

userFolderClass - The class that extends UserFolder

uuid - The users UUID

Returns:

The initialized class

Throws:

NoSuchMethodException - Thrown on failed class initialization

InvocationTargetException - Thrown on failed class initialization

InstantiationException - Thrown on failed class initialization

IllegalAccessException - Thrown on failed class initialization

NoUserJsonFoundException - Thrown when you have not called the UserFolder.loadData(Class, String) method.

saveUserData

public void saveUserData(UserFolder folder)
                  throws IOException

Used for saving the users data

Parameters:

folder - The UserFolder class

Throws:

IOException - thrown by ConfigLoader.saveConfig(Object, File)

saveAllUserData

public void saveAllUserData()
                     throws IOException

Used for saving all users data

Throws:

IOException - thrown by ConfigLoader.saveConfig(Object, File)