From 95e20e405442b678f49e48af00970e8a55b66f6e Mon Sep 17 00:00:00 2001
From: Katarina <katarinaking361@gmail.com>
Date: Sat, 15 Jun 2024 01:20:52 +0000
Subject: [PATCH] MNEMONIC-832: EntityInfo Class Comments

---
 .../mnemonic/query/memory/EntityInfo.java     | 37 +++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/mnemonic-common/src/main/java/org/apache/mnemonic/query/memory/EntityInfo.java b/mnemonic-common/src/main/java/org/apache/mnemonic/query/memory/EntityInfo.java
index 5dabeb18..98a93bb2 100644
--- a/mnemonic-common/src/main/java/org/apache/mnemonic/query/memory/EntityInfo.java
+++ b/mnemonic-common/src/main/java/org/apache/mnemonic/query/memory/EntityInfo.java
@@ -16,34 +16,71 @@
  */
 package org.apache.mnemonic.query.memory;
 
+/**
+ * The EntityInfo class represents metadata about an entity in the Mnemonic framework.
+ * It holds information about the entity's class name, entity name, and its attributes.
+ */
 public class EntityInfo {
 
+  // The fully qualified class name of the entity.
   private String className;
 
+  // The name of the entity.
   private String entityName;
 
+  // An array of AttributeInfo objects, representing the attributes of the entity.
   private AttributeInfo[] attributeInfo;
 
+  /**
+   * Gets the class name of the entity.
+   *
+   * @return the class name as a String.
+   */
   public String getClassName() {
     return className;
   }
 
+  /**
+   * Sets the class name of the entity.
+   *
+   * @param className the class name to set.
+   */
   public void setClassName(String className) {
     this.className = className;
   }
 
+  /**
+   * Gets the name of the entity.
+   *
+   * @return the entity name as a String.
+   */
   public String getEntityName() {
     return entityName;
   }
 
+  /**
+   * Sets the name of the entity.
+   *
+   * @param entityName the entity name to set.
+   */
   public void setEntityName(String entityName) {
     this.entityName = entityName;
   }
 
+  /**
+   * Gets the array of AttributeInfo objects associated with the entity.
+   *
+   * @return an array of AttributeInfo objects.
+   */
   public AttributeInfo[] getAttributeInfo() {
     return attributeInfo;
   }
 
+  /**
+   * Sets the array of AttributeInfo objects for the entity.
+   *
+   * @param attributeInfo an array of AttributeInfo objects to set.
+   */
   public void setAttributeInfo(AttributeInfo[] attributeInfo) {
     this.attributeInfo = attributeInfo;
   }