Improve variable declaration to improve usability (#22)

Author: theEvilReaper

src/main/java/net/onelitefeather/vulpes/api/model/AttributeEntity.java

@@ -24,8 +24,8 @@ public class AttributeEntity implements VulpesModel {
     @GeneratedValue(strategy = GenerationType.UUID)
     @VulpesGenerator
     private UUID id;
-    private String modelName;
-    private String name;
+    private String uiName;
+    private String variableName;
     private double defaultValue;
     private double maximumValue;
 
@@ -43,15 +43,15 @@ public AttributeEntity() {
      * Constructs a new {@link AttributeEntity} with the specified values.
      *
      * @param id            the unique identifier of the attribute
-     * @param modelName     the model name associated with the attribute
-     * @param name          the name of the attribute
+     * @param uiName     the model name associated with the attribute
+     * @param variableName          the name of the attribute
      * @param defaultValue  the default value of the attribute
      * @param maximumValue  the maximum value of the attribute
      */
-    public AttributeEntity(UUID id, String modelName, String name, double defaultValue, double maximumValue) {
+    public AttributeEntity(UUID id, String uiName, String variableName, double defaultValue, double maximumValue) {
         this.id = id;
-        this.modelName = modelName;
-        this.name = name;
+        this.uiName = uiName;
+        this.variableName = variableName;
         this.defaultValue = defaultValue;
         this.maximumValue = maximumValue;
     }
@@ -81,35 +81,35 @@ public void setId(UUID id) {
      *
      * @return the model name of the attribute
      */
-    public String getModelName() {
-        return modelName;
+    public String getUiName() {
+        return uiName;
     }
 
     /**
      * Sets the model name associated with the attribute
      *
      * @param modelName the model name to set
      */
-    public void setModelName(String modelName) {
-        this.modelName = modelName;
+    public void setUiName(String modelName) {
+        this.uiName = modelName;
     }
 
     /**
      * Returns the name of the attribute
      *
      * @return the name of the attribute
      */
-    public String getName() {
-        return name;
+    public String getVariableName() {
+        return variableName;
     }
 
     /**
      * Sets the name of the attribute
      *
      * @param name the name to set
      */
-    public void setName(String name) {
-        this.name = name;
+    public void setVariableName(String name) {
+        this.variableName = name;
     }
 
     /**
@@ -157,8 +157,8 @@ public void setMaximumValue(double maximumValue) {
     public String toString() {
         return "AttributeModel{" +
                 "id='" + id + '\'' +
-                ", modelName='" + modelName + '\'' +
-                ", name='" + name + '\'' +
+                ", modelName='" + uiName + '\'' +
+                ", name='" + variableName + '\'' +
                 ", defaultValue=" + defaultValue +
                 ", maximumValue=" + maximumValue +
                 '}';

src/main/java/net/onelitefeather/vulpes/api/model/ItemEntity.java

@@ -28,9 +28,9 @@ public class ItemEntity implements VulpesModel {
     @VulpesGenerator
     private UUID id;
 
-    private String modelName;
-    private String name;
-    private String description;
+    private String uiName;
+    private String variableName;
+    private String comment;
     private String displayName;
     private String material;
     private String groupName;
@@ -57,23 +57,23 @@ public ItemEntity() {
      * Constructs a new {@link ItemEntity} with the specified values.
      *
      * @param id              the unique identifier of the item
-     * @param modelName       the model name associated with the item
-     * @param name            the name of the item
-     * @param description     a description of the item
+     * @param uiName          the model name associated with the item
+     * @param variableName    the name of the item
+     * @param comment         a description of the item
      * @param displayName     the display name of the item
      * @param material        the material type associated with the item
-     * @param groupName           the group to which the item belongs
+     * @param groupName       the group to which the item belongs
      * @param customModelData the custom model data for the item
      * @param amount          the amount of the item
      * @param enchantments    the enchantments applied to the item
      * @param lore            the lore associated with the item
      * @param flags           the flags associated with the item
      */
-    public ItemEntity(UUID id, String modelName, String name, String description, String displayName, String material, String groupName, int customModelData, int amount, Map<String, Short> enchantments, List<String> lore, List<String> flags) {
+    public ItemEntity(UUID id, String uiName, String variableName, String comment, String displayName, String material, String groupName, int customModelData, int amount, Map<String, Short> enchantments, List<String> lore, List<String> flags) {
         this.id = id;
-        this.modelName = modelName;
-        this.name = name;
-        this.description = description;
+        this.uiName = uiName;
+        this.variableName = variableName;
+        this.comment = comment;
         this.displayName = displayName;
         this.material = material;
         this.groupName = groupName;
@@ -105,59 +105,60 @@ public void setId(UUID id) {
     }
 
     /**
-     * Returns the model name associated with the item.
+     * Sets the name representation for the ui
      *
-     * @return the model name of the item
+     * @param uiName the name to set for the ui
      */
-    public String getModelName() {
-        return modelName;
+    public void setUiName(String uiName) {
+        this.uiName = uiName;
     }
 
     /**
-     * Sets the model name associated with the item.
+     * Returns the name representation for the ui
      *
-     * @param modelName the model name to set
+     * @return the given ui name
      */
-    public void setModelName(String modelName) {
-        this.modelName = modelName;
+    public String getUiName() {
+        return uiName;
     }
 
     /**
-     * Returns the name of the item.
+     * Sets the variable name for the notification
      *
-     * @return the name of the item
+     * @param variableName the variable name to set
      */
-    public String getName() {
-        return name;
+    public void setVariableName(String variableName) {
+        this.variableName = variableName;
     }
 
     /**
-     * Sets the name of the item.
+     * Returns the variable name for the notification
      *
-     * @param name the name to set
+     * @return the variable name of the notification
      */
-    public void setName(String name) {
-        this.name = name;
+    public String getVariableName() {
+        return variableName;
     }
 
     /**
-     * Returns the description of the item.
+     * Returns the comment of the notification
      *
-     * @return the description of the item
+     * @return the description
      */
-    public String getDescription() {
-        return description;
+    public String getComment() {
+        return comment;
     }
 
     /**
-     * Sets the description of the item.
+     * Sets the comment of the notification
      *
-     * @param description the description to set
+     * @param description the comment to set
      */
-    public void setDescription(String description) {
-        this.description = description;
+    public void setComment(String description) {
+        this.comment = description;
     }
 
+
     /**
      * Returns the display name of the item.
      *
@@ -311,9 +312,9 @@ public void setFlags(List<String> flags) {
     public String toString() {
         return "ItemModel{" +
                 "id='" + id + '\'' +
-                ", modelName='" + modelName + '\'' +
-                ", name='" + name + '\'' +
-                ", description='" + description + '\'' +
+                ", modelName='" + uiName + '\'' +
+                ", name='" + variableName + '\'' +
+                ", comment='" + comment + '\'' +
                 ", displayName='" + displayName + '\'' +
                 ", material='" + material + '\'' +
                 ", group='" + groupName + '\'' +

src/main/java/net/onelitefeather/vulpes/api/model/NotificationEntity.java

@@ -24,9 +24,9 @@ public class NotificationEntity implements VulpesModel {
     @GeneratedValue(strategy = GenerationType.UUID)
     @VulpesGenerator
     private UUID id;
-    private String modelName;
-    private String name;
-    private String description;
+    private String uiName;
+    private String variableName;
+    private String comment;
     private String material;
     private String frameType;
     private String title;
@@ -44,19 +44,17 @@ public NotificationEntity() {
     /**
      * Constructs a new {@link NotificationEntity} with the specified values.
      *
-     * @param id          the unique identifier of the notification
-     * @param modelName   the model name associated with the notification
-     * @param name        the name of the notification
-     * @param description a description of the notification
-     * @param material    the material type associated with the notification
-     * @param frameType   the frame type associated with the notification
-     * @param title       the title of the notification
+     * @param id        the unique identifier of the notification
+     * @param comment   a comment for the description
+     * @param material  the material type associated with the notification
+     * @param frameType the frame type associated with the notification
+     * @param title     the title of the notification
      */
-    public NotificationEntity(UUID id, String modelName, String name, String description, String material, String frameType, String title) {
+    public NotificationEntity(UUID id, String uiName, String variableName, String comment, String material, String frameType, String title) {
         this.id = id;
-        this.modelName = modelName;
-        this.name = name;
-        this.description = description;
+        this.uiName = uiName;
+        this.variableName = variableName;
+        this.comment = comment;
         this.material = material;
         this.frameType = frameType;
         this.title = title;
@@ -81,57 +79,57 @@ public void setId(UUID id) {
     }
 
     /**
-     * Returns the model name associated with the notification
+     * Sets the name representation for the ui
      *
-     * @return the model name of the notification
+     * @param uiName the name to set for the ui
      */
-    public String getModelName() {
-        return modelName;
+    public void setUiName(String uiName) {
+        this.uiName = uiName;
     }
 
     /**
-     * Sets the model name associated with the notification
+     * Returns the name representation for the ui
      *
-     * @param modelName the model name to set
+     * @return the given ui name
      */
-    public void setModelName(String modelName) {
-        this.modelName = modelName;
+    public String getUiName() {
+        return uiName;
     }
 
     /**
-     * Returns the name of the notification
+     * Sets the variable name for the notification
      *
-     * @return the name of the notification
+     * @param variableName the variable name to set
      */
-    public String getName() {
-        return name;
+    public void setVariableName(String variableName) {
+        this.variableName = variableName;
     }
 
     /**
-     * Sets the name of the notification
+     * Returns the variable name for the notification
      *
-     * @param name the name to set
+     * @return the variable name of the notification
      */
-    public void setName(String name) {
-        this.name = name;
+    public String getVariableName() {
+        return variableName;
     }
 
     /**
-     * Returns the description of the notification
+     * Returns the comment of the notification
      *
-     * @return the description of the notification
+     * @return the description
      */
-    public String getDescription() {
-        return description;
+    public String getComment() {
+        return comment;
     }
 
     /**
-     * Sets the description of the notification
+     * Sets the comment of the notification
      *
-     * @param description the description to set
+     * @param description the comment to set
      */
-    public void setDescription(String description) {
-        this.description = description;
+    public void setComment(String description) {
+        this.comment = description;
     }
 
     /**
@@ -197,9 +195,9 @@ public void setTitle(String title) {
     public String toString() {
         return "NotificationModel{" +
                 "id='" + id + '\'' +
-                ", modelName='" + modelName + '\'' +
-                ", name='" + name + '\'' +
-                ", description='" + description + '\'' +
+                ", uiName='" + uiName + '\'' +
+                ", variableName='" + variableName + '\'' +
+                ", description='" + comment + '\'' +
                 ", material='" + material + '\'' +
                 ", frameType='" + frameType + '\'' +
                 ", title='" + title + '\'' +