chore(entities): add documentation and improve constructor definition

Author: theEvilReaper

src/main/java/net/onelitefeather/vulpes/api/model/font/FontStringEntity.java

@@ -24,49 +24,98 @@ public final class FontStringEntity implements Comparable<FontStringEntity> {
     private FontEntity font;
     private int orderIndex;
 
+    /**
+     * Default constructor for JPA.
+     */
     public FontStringEntity() {
+        // No-argument constructor for JPA
     }
 
+    /**
+     * Constructs a new {@link FontStringEntity} with the specified values.
+     *
+     * @param id         the unique identifier of the font string
+     * @param content    the content of the font string
+     * @param orderIndex the order index of the font string
+     */
     public FontStringEntity(
             UUID id,
             String content,
-            FontEntity font,
             int orderIndex
     ) {
         this.id = id;
         this.line = content;
-        this.font = font;
         this.orderIndex = orderIndex;
     }
 
+    /**
+     * Sets the unique identifier of the font string.
+     *
+     * @param id the unique identifier to set
+     */
     public void setId(UUID id) {
         this.id = id;
     }
 
+    /**
+     * Gets the unique identifier of the font string.
+     *
+     * @return the unique identifier
+     */
     public UUID getId() {
         return id;
     }
 
+    /**
+     * Sets the content of the font string.
+     *
+     * @param line the content to set
+     */
     public void setLine(String line) {
         this.line = line;
     }
 
+    /**
+     * Gets the content of the font string.
+     *
+     * @return the content
+     */
     public String getLine() {
         return line;
     }
 
+    /**
+     * Sets the font associated with this font string.
+     *
+     * @param font the font to set
+     */
     public void setFont(FontEntity font) {
         this.font = font;
     }
 
+    /**
+     * Gets the font associated with this font string.
+     *
+     * @return the font
+     */
     public FontEntity getFont() {
         return font;
     }
 
+    /**
+     * Sets the order index of the font string.
+     *
+     * @param orderIndex the order index to set
+     */
     public void setOrderIndex(int orderIndex) {
         this.orderIndex = orderIndex;
     }
 
+    /**
+     * Gets the order index of the font string.
+     *
+     * @return the order index
+     */
     public int getOrderIndex() {
         return orderIndex;
     }

src/main/java/net/onelitefeather/vulpes/api/model/item/ItemEnchantmentEntity.java

@@ -24,50 +24,98 @@ public final class ItemEnchantmentEntity {
     @JoinColumn(name = "item_id", nullable = false)
     private ItemEntity item;
 
+    /**
+     * Default constructor for JPA and Micronaut Data.
+     */
     public ItemEnchantmentEntity() {
-
+        // No-argument constructor for JPA
     }
 
+    /**
+     * Constructs a new {@link ItemEnchantmentEntity} with the specified values.
+     *
+     * @param id    the unique identifier of the item enchantment
+     * @param name  the name of the enchantment
+     * @param level the level of the enchantment
+     */
     public ItemEnchantmentEntity(
             UUID id,
             String name,
-            short level,
-            ItemEntity item
+            short level
     ) {
         this.id = id;
         this.name = name;
         this.level = level;
-        this.item = item;
     }
 
+    /**
+     * Returns the unique identifier of the item enchantment.
+     *
+     * @return the id
+     */
     public UUID getId() {
         return id;
     }
 
+    /**
+     * Sets the unique identifier of the item enchantment.
+     *
+     * @param id the id to set
+     */
     public void setId(UUID id) {
         this.id = id;
     }
 
+    /**
+     * Returns the name of the enchantment.
+     *
+     * @return the name
+     */
     public String getName() {
         return name;
     }
 
+    /**
+     * Sets the name of the enchantment.
+     *
+     * @param name the name to set
+     */
     public void setName(String name) {
         this.name = name;
     }
 
+    /**
+     * Returns the level of the enchantment.
+     *
+     * @return the level
+     */
     public short getLevel() {
         return level;
     }
 
+    /**
+     * Sets the level of the enchantment.
+     *
+     * @param level the level to set
+     */
     public void setLevel(short level) {
         this.level = level;
     }
 
+    /**
+     * Returns the {@link ItemEntity} which is linked with this enchantment.
+     *
+     * @return the item associated with this enchantment
+     */
     public ItemEntity getItem() {
         return item;
     }
 
+    /**
+     * Sets the item associated with this enchantment.
+     *
+     * @param item the item to associate with this enchantment
+     */
     public void setItem(ItemEntity item) {
         this.item = item;
     }

src/main/java/net/onelitefeather/vulpes/api/model/item/ItemFlagEntity.java

@@ -15,56 +15,92 @@
 /**
  * The {@link ItemFlagEntity} represents a flag or attribute that can be associated with an item in the system.
  *
+ * @author theEvilReaper
+ * @version 1.1.0
+ * @since 1.6.0
  */
 @Entity(name = "item_flags")
 public final class ItemFlagEntity {
     @Id
     @GeneratedValue(strategy = GenerationType.UUID)
     @VulpesGenerator
     private UUID id;
-    private String text;
+    private String flag;
     @ManyToOne
     @JoinColumn(name = "item_id")
     private ItemEntity item;
 
     /**
+     * Default constructor for JPA and Micronaut Data.
+     */
+    public ItemFlagEntity() {
+        // No-argument constructor for JPA
+    }
+
+    /**
+     * Constructs a new {@link ItemFlagEntity} with the specified parameters.
+     *
      * @param id   the unique identifier of the item flag
-     * @param text the descriptive text of the item flag
+     * @param flag the descriptive text of the item flag
      */
     public ItemFlagEntity(
             UUID id,
-            String text,
-            ItemEntity item
+            String flag
     ) {
         this.id = id;
-        this.text = text;
-        this.item = item;
-    }
-
-    public ItemFlagEntity() {
-
+        this.flag = flag;
     }
 
+    /**
+     * Sets the unique identifier of the item flag.
+     *
+     * @param id the unique identifier to set
+     */
     public void setId(UUID id) {
         this.id = id;
     }
 
+    /**
+     * Gets the unique identifier of the item flag.
+     *
+     * @return the unique identifier
+     */
     public UUID getId() {
         return id;
     }
 
-    public void setText(String text) {
-        this.text = text;
+    /**
+     * Sets the flag associated with the item.
+     *
+     * @param flag the item flag
+     */
+    public void setFlag(String flag) {
+        this.flag = flag;
     }
 
-    public String getText() {
-        return text;
+    /**
+     * Gets the flag associated with the item.
+     *
+     * @return the item flag
+     */
+    public String getFlag() {
+        return flag;
     }
 
+    /**
+     * Sets the item associated with this flag.
+     *
+     * @param item the item to associate
+     */
     public void setItem(ItemEntity item) {
         this.item = item;
     }
 
+    /**
+     * Gets the item associated with this flag.
+     *
+     * @return the associated item
+     */
     public ItemEntity getItem() {
         return item;
     }
@@ -75,22 +111,20 @@ public boolean equals(Object obj) {
         if (obj == null || obj.getClass() != this.getClass()) return false;
         var that = (ItemFlagEntity) obj;
         return Objects.equals(this.id, that.id) &&
-                Objects.equals(this.text, that.text) &&
+                Objects.equals(this.flag, that.flag) &&
                 Objects.equals(this.item, that.item);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(id, text, item);
+        return Objects.hash(id, flag, item);
     }
 
     @Override
     public String toString() {
         return "ItemFlagEntity[" +
                 "id=" + id + ", " +
-                "text=" + text + ", " +
+                "text=" + flag + ", " +
                 "item=" + item + ']';
     }
-
-
 }