Update DataStructure.java

yanglbme · web-flow · commit 965c288b3a4a · 2019-03-06T08:58:11.000+08:00
diff --git a/src/main/java/com/types/DataStructure.java b/src/main/java/com/types/DataStructure.java
@@ -6,26 +6,52 @@
  * This interface is to define bacis functionality expected out of any implementation class
  * Since this is a data structure it should have the flexibility to contain any kind of object hence it has been made generic
  * Any implementation class need not to be thread safe or it could be depending on the implementation class how does it want to behave.
+ *
  * @param <T>
  */
 public interface DataStructure<T> extends Iterator<T> {
 
-    //Method to add element in the structure
-    public boolean add(T t);
-
-    //Method to remove the given object from structure
-    public boolean remove(T o);
-
-    //Method to get Iterator to parse on the given structure
-    public Iterator<T> iterator();
-
-    //Method to check if structure is empty
-    public boolean isEmpty();
-
-    //Method to get all the elements of data structure in array
-    public Object[] toArray();
-
-    //Method to get the size or number of elements in structure
-    public int size();
-
+    /**
+     * Method to add element in the structure
+     *
+     * @param t element
+     * @return boolean
+     */
+    boolean add(T t);
+
+    /**
+     * Method to remove the given object from structure
+     *
+     * @param o element
+     * @return boolean
+     */
+    boolean remove(T o);
+
+    /**
+     * Method to get Iterator to parse on the given structure
+     *
+     * @return iterator
+     */
+    Iterator<T> iterator();
+
+    /**
+     * Method to check if structure is empty
+     *
+     * @return boolean
+     */
+    boolean isEmpty();
+
+    /**
+     * Method to get all the elements of data structure in array
+     *
+     * @return arr
+     */
+    Object[] toArray();
+
+    /**
+     * Method to get the size or number of elements in structure
+     *
+     * @return size
+     */
+    int size();
 }
