Final bugs removed. Project done!

Author: apfel-das

input.txt

@@ -1,3 +1,12 @@
-This is the first line
-This is the second line
-This is the 3rd Line which is exceeding limit of 10 ASCII characters. Thus it will be trimmed.
+Each
+Each
+Each
+Each
+Dich
+Snitch
+Toum
+Tam . Each Each Each ? Each Tam
+Tik Tok Bop
+RichN
+Bitch
+MMMM

input.txt.ndx

@@ -1,14 +1,29 @@
-package Files;
+  package Files;
 import java.io.*;
 import java.util.ArrayList;
 import java.util.Collections;
 
-import test.*;
+import textEditor.*;
 import util.Item;
 import util.List;
 import util.Node;
 import util.Word;
 
+/**
+ * 
+ *
+ * {@summary }
+ * 	A class to encapsulate methods for performing r/w operations on regular Files
+ *  @author dasApfel - Konstantinos Pantelis
+ *  
+ *  @see  FileInputStream FileOutputStream InputStreamReader OutputStreamReader BufferedReader BufferedWriter
+ *  
+ * 
+ *  
+ 
+ */
+
+
 public class FileOps {
 
 	private File f;
@@ -18,6 +33,16 @@ public class FileOps {
 	final int tokenSize = maxSize + 4;
 
 
+	/**
+	 * Class constructor
+	 * @param fNam Filename as String
+	 * @param l    List instance
+	 * @param t	   Threshold of a line
+	 * @param low  Word lower boundary
+	 * @param up   Word upper boundary
+	 * @throws FileNotFoundException
+	 */
+	
 	public FileOps(String fNam,List l, int t,int low, int up) throws FileNotFoundException 
 	{
 
@@ -32,11 +57,29 @@ public FileOps(String fNam,List l, int t,int low, int up) throws FileNotFoundExc
 
 	}
 
+	/**
+	 * 
+	 * A getter function
+	 */
 	public File getFile() 
 	{
 		return this.f;
 	}
 
+	/**
+	 * 
+	 * A function to read a file line - wise and store its context if between {@code (minSize, maxSize)} in a double linked list, else ignores the given context.
+	 * 
+	 * @throws IOException
+	 * @throws FileNotFoundException
+	 *
+	 * @implNote Uses the function {@link Files.FileOps.formatInput()} formatInput to decide whether input will be ignored or not.
+	 * @see  BufferdReader 
+	 * @see InputStreamReader
+	 * @see FileInputStream
+	 * 	
+	 */
+	
 	public void retrieveContext() throws IOException,FileNotFoundException
 	{
 		BufferedReader r = new BufferedReader(new InputStreamReader(new FileInputStream(f)));
@@ -80,6 +123,20 @@ public void retrieveContext() throws IOException,FileNotFoundException
 	 * 
 	 * */
 
+	/**
+	 * 
+	 * 	A function to store the context of a double linked list, in a .txt file.
+	 * 
+	 * @throws IOException
+	 * @throws FileNotFoundException
+	 *
+	 * @implNote Stores the context in the same input file by overwriting its content.
+	 * @see  BufferdWritter 
+	 * @see OutputStreamWriter 
+	 * @see FileOutputStream
+	 * 	
+	 */
+	
 	public void storeContext() throws IOException,FileNotFoundException 
 	{
 
@@ -113,6 +170,33 @@ public void storeContext() throws IOException,FileNotFoundException
 	 * 	-Trims given string - input in case that this exceeds threshold characters.
 	 * 
 	 * */
+	/**
+	 * Constructs a LineItem if the given key {@literal String} matches the requirements. If not key is either trimmed or null is returned (empty key given) 
+	 * <br><strong>Key Requirements: </strong> 
+	 * 							
+	 * 	<blockquote>If a key is greater than {@code threshold} the key gets trimmed to fit the [0, threshold] range.</blockquote>
+	 *	<blockquote>If an empty key is given ({@code lContext.isEmpty() == true}) null is returned.</blockquote>	
+	 * 
+	 * 
+	 *  
+	 * 
+	 * 
+	 * 
+	 * 
+	 *
+	 * 
+	 * 
+	 * 
+	 *  
+	 * @param lContext A String key.
+	 * @param lNum The line in which this key is found inside the text.
+	 * @return A LineItem if the key is valid or null.
+	 * @see  util.Item 
+	 * @see  textEditorLineItem 
+	 * @see	 util.List
+	 * 
+	 * 
+	 */
 
 	public static Item formatInput(String lContext, int lNum) 
 	{
@@ -146,6 +230,24 @@ public static Item formatInput(String lContext, int lNum)
 	 * 
 	 * */
 
+	
+	/**
+	 *Itterates through the double linked list of Line objects ({@linkplain textEditor.Line}) and stores each valid word in an ArrayList of Word objects ({@linkplain util.Word}). 
+	 * <blockquote> The splitting procedure uses a regex in order to be performed. </blockquote>
+	 * <blockquote> <strong> Valid Words (Keys): </strong></blockquote>
+	 * <blockquote>
+	 * 		<ul>
+	 * 				<li> Any String that is delimited via the "\W+" regular expression is possibly valid.</li>
+	 * 				<li> Any possibly valid string that has a  {@code key.length()} &#8707; {@code [minSize, maxSize]} is valid. </li>
+	 * 	 	</ul> 
+	 * </blockquote>
+	 * @implNote <ul> 
+	 * 					<li>Validity of a possibly valid Word - Key is checked via the {@code isValidWord()} function. </li>
+	 * 					<li>The final ArrayList gets sorted after it is filled.</li> 
+	 * 			</ul>
+	 * 
+	 * @return An {@literal ArrayList} of Word (- s) objects retrieved from the list in an ascending lexicographical order.
+	 */
 	public ArrayList<Word> fillWordMap()
 	{
 		int index = 0;
@@ -186,11 +288,15 @@ public ArrayList<Word> fillWordMap()
 
 		}
 
+		
+		
 		//sort the array list based on the "word"-key.
 		Collections.sort(words);
 
 		///return the sorted arraylist.
 
+		
+		
 		return words;
 
 
@@ -205,7 +311,12 @@ public ArrayList<Word> fillWordMap()
 	 * Stores a created line item in a double linked list.
 	 * 
 	 * */
-	
+	/**
+	 * Gets a List instance and a LineItem and appends the given Item at the end of the list.
+	 * @param l A list reference.
+	 * @param line A line item.
+	 * @return Nothing
+	 */
 	public void storeLine(List l, LineItem line) 
 	{
 
@@ -217,6 +328,14 @@ public void storeLine(List l, LineItem line)
 	 * Decides for the validity of the given string based on thresholds. (see FileOps class constructor).
 	 * 
 	 * */
+	/**
+	 * Gets a String representing an actual key and decides whether is valid or not by checking its length which should  &#8707; [minSize, maxSize].
+	 * @param w
+	 * @return True if given is valid, or False
+	 * 
+	 * 
+	 * @see Files.FileOps.fillWordMap
+	 */
 
 	private boolean isValidWord(String w) 
 	{

src/Files/FileOps.java

@@ -8,16 +8,35 @@
 
 import util.Word;
 
+/**
+ * 
+ * 
+ * @author dasApfel - Konstantinos Pantelis
+ * {@summary }
+ * A class to encapsulate methods for performing r/w operations on RandomAccessFiles representing a dictionary (see {@linkplain RandomAccessFile} for more).
+ *
+ */
+
 public class FilePageAccess 
 {
 
+	
+	
 	private int pageSize;
 	private int tokenSize;
 	private int dataPages;
 	private int keySize;
 	RandomAccessFile dF;
 	ArrayList<Word> words;
 
+	
+	/**
+	 * 
+	 * @param ps Size of a datapage in bytes.
+	 * @param k  Tuple of {@literal <String, Integer>} maximum size in bytes.
+	 * @param f  The name of a {@linkplain RandomAccessFile} to write the data in bytes, passed as a {@literal String}.
+	 * @throws FileNotFoundException
+	 */
 	public FilePageAccess(int ps, int k,String f) throws FileNotFoundException 
 	{
 		pageSize = ps;
@@ -44,6 +63,17 @@ public int getPageSize()
 	 * Filling gets to happen in quantums of pageSize which can easily be altered.
 	 * */
 
+	/**
+	 * 
+	 * Gets an {@linkplain ArrayList} of {@code Word.class} (tuples of {@literal <String, Integer> }) and fills a RandomAccessFile page - wise.
+	 * Uses a {@literal ByteBuffer} {@linkplain java.nio.ByteBuffer} in which {@code pageSize} bytes are allocated.
+	 * 
+	 * @param words Tuples of {@literal <String, Integer>} as an {@linkplain ArrayList}.
+	 * @throws IOException
+	 * @throws FileNotFoundException
+	 * @return Nothing, only informs the {@code int datapages} which depicts the number of pages present.
+	 * 
+	 */
 
 	public void fillDictionary(ArrayList<Word> words) throws IOException,FileNotFoundException 
 	{
@@ -105,9 +135,10 @@ public void fillDictionary(ArrayList<Word> words) throws IOException,FileNotFoun
 
 	}
 
-	/*
-	 * Read a dictionary (RandomAccessFile) page - wise,at once.
-	 * Return the information retrieved in an arraylist. 
+	/**
+	 * 
+	 * Reads a dictionary ({@literal RandomAccessFile}) page - wise,at once by utilising {@code readPage(int pageNum)} method.
+	 * @return The information retrieved in an {@linkplain ArrayList}. 
 	 * 
 	 * 
 	 * */
@@ -134,6 +165,13 @@ public ArrayList<Word> readDictionary() throws NullPointerException, IOException
 
 	}
 
+	/**
+	 * Reads a page of the dictionary - {@literal RandomAccessFile} by utilizing a ByteBuffer (see {@linkplain java.nio.ByteBuffer})
+	 * @param pageNum Specifies the page to be accessed/read.
+	 * @return The page specified as an ArrayList (see {@linkplain java.util.ArrayList} for more).
+	 * @throws IOException
+	 * @throws NullPointerException
+	 */
 
 	public ArrayList<Word> readPage(int pageNum) throws IOException,NullPointerException 
 	{
@@ -199,9 +237,17 @@ public ArrayList<Word> readPage(int pageNum) throws IOException,NullPointerExcep
 	}
 
 	/*
-	 * Fill the missing parts of a string -> byte conversion with spaces (ASCII 32).
+	 * Fills the missing parts of a string -> byte conversion with spaces (ASCII 32).
 	 * 
 	 * */
+	
+	/**
+	 * Space - padding of a byte array representing a {@literal String} key.
+	 * @param s A byte array containing the byte representation of a {@literal String} key.
+	 * @return	A byte array containing the byte representation of a {@literal String} key, filled up with spaces (ASCII 32) if {@code key.length < tokenSize } 
+	 *  
+	 */
+	
 	private byte[] paddBytes(byte s[]) 
 	{
 
@@ -227,12 +273,21 @@ private byte[] paddBytes(byte s[])
 	 * 
 	 * */
 
+	/**
+	 * Closes open File.
+	 * @throws IOException
+	 */
 	public void close() throws IOException 
 	{
 		dF.close();
 
 	}
 
+	/**
+	 * prints a File content after retrieved.
+	 * @throws NullPointerException
+	 * @throws IOException
+	 */
 	public void printFile( ) throws NullPointerException, IOException 
 	{