Upstream/bentobox
1
0
Fork 0
mirror of https://github.com/BentoBoxWorld/BentoBox.git synced 2024-11-28 13:45:14 +01:00
Code Issues Projects Releases Wiki Activity

Added comments and TODO's to FlatFileDatabaseHandler

Browse Source
This commit is contained in:
tastybento 2018-08-14 18:43:51 -07:00
parent 05ca21b0cd
commit baf6571614
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/main/java/world/bentobox/bentobox/database/flatfile/FlatFileDatabaseHandler.java
View File

@ -161,8 +161,12 @@ public class FlatFileDatabaseHandler<T> extends AbstractDatabaseHandler<T> {
// If there is a config annotation then do something // If there is a config annotation then do something
if (configEntry != null && !configEntry.path().isEmpty()) { if (configEntry != null && !configEntry.path().isEmpty()) {
storageLocation = configEntry.path(); storageLocation = configEntry.path();
// TODO: Not sure what to do with this one
overrideOnChange = configEntry.overrideOnChange(); overrideOnChange = configEntry.overrideOnChange();
// TODO: Not sure what to do with this one
experimental = configEntry.experimental(); experimental = configEntry.experimental();
// If this value has changed, then the addon will need a full reset
// TODO: Inform addon if this value is different to a value stored in the database?
needsReset = configEntry.needsReset(); needsReset = configEntry.needsReset();
} }
// Some fields need custom handling to serialize or deserialize and the programmer will need to // Some fields need custom handling to serialize or deserialize and the programmer will need to
@ -428,23 +432,28 @@ public class FlatFileDatabaseHandler<T> extends AbstractDatabaseHandler<T> {
} }
/** /**
* Serialize an object if required * Serialize an object if required. This means that an object will be turned into text to store in YAML
* @param object - object to serialize * @param object - object to serialize
* @return - serialized object * @return - serialized object
*/ */
private Object serialize(Object object) { private Object serialize(Object object) {
// Null is a value object and is serialized as the string "null"
if (object == null) { if (object == null) {
return "null"; return "null";
} }
// UUID has it's own serialization, that is not picked up automatically
if (object instanceof UUID) { if (object instanceof UUID) {
return ((UUID)object).toString(); return ((UUID)object).toString();
} }
// Only the world name is needed for worlds
if (object instanceof World) { if (object instanceof World) {
return ((World)object).getName(); return ((World)object).getName();
} }
// Location
if (object instanceof Location) { if (object instanceof Location) {
return Util.getStringLocation((Location)object); return Util.getStringLocation((Location)object);
} }
// Enums
if (object instanceof Enum) { if (object instanceof Enum) {
//Custom enums are a child of the Enum class. Just get the names of each one. //Custom enums are a child of the Enum class. Just get the names of each one.
return ((Enum<?>)object).name(); return ((Enum<?>)object).name();
@ -520,19 +529,24 @@ public class FlatFileDatabaseHandler<T> extends AbstractDatabaseHandler<T> {
return value; return value;
} }
/* (non-Javadoc)
* @see world.bentobox.bentobox.database.AbstractDatabaseHandler#deleteObject(java.lang.Object)
*/
@Override @Override
public void deleteObject(T instance) throws IllegalAccessException, InvocationTargetException, IntrospectionException { public void deleteObject(T instance) throws IllegalAccessException, InvocationTargetException, IntrospectionException {
// The file name of the Yaml file. // Obtain the value of uniqueId within the instance (which must be a DataObject)
PropertyDescriptor propertyDescriptor = new PropertyDescriptor("uniqueId", dataObject); PropertyDescriptor propertyDescriptor = new PropertyDescriptor("uniqueId", dataObject);
Method method = propertyDescriptor.getReadMethod(); Method method = propertyDescriptor.getReadMethod();
String fileName = (String) method.invoke(instance); String fileName = (String) method.invoke(instance);
// The filename of the YAML file is the value of uniqueId field plus .yml. Sometimes the .yml is already appended.
if (!fileName.endsWith(".yml")) { if (!fileName.endsWith(".yml")) {
fileName = fileName + ".yml"; fileName = fileName + ".yml";
} }
// Get the database and table folders
File dataFolder = new File(plugin.getDataFolder(), DATABASE_FOLDER_NAME); File dataFolder = new File(plugin.getDataFolder(), DATABASE_FOLDER_NAME);
File tableFolder = new File(dataFolder, dataObject.getSimpleName()); File tableFolder = new File(dataFolder, dataObject.getSimpleName());
if (tableFolder.exists()) { if (tableFolder.exists()) {
// Obtain the file and delete it
File file = new File(tableFolder, fileName); File file = new File(tableFolder, fileName);
try { try {
Files.delete(file.toPath()); Files.delete(file.toPath());