Merge remote-tracking branch 'origin/master'

README.md

@@ -0,0 +1,25 @@
+# basic-text-editor
+
+A basic Text Editor created using Java and Swing.
+
+## Functionalities Included:
+ - A 1920x1080 window
+ - Loading text files from hard drive for editing
+ - Finding occurences of a specific string using the search bar on the editor window
+ - Saving file to hard drive
+
+## Supported File Types
+ - .txt
+ - .rtf
+ - .csv
+ - .json
+ - .md
+ - other forms of text files...
+
+ Makes it a good tool for cleaning data and finding specific entries used in fields such as Data Science which deal with these file formats, with an easy to use GUI.
+
+## How to Run:
+ - Download here: [TextEditor.exe](https://github.com/kritgrover/basic-text-editor/releases)
+ - Run
+
+All source files used to compile executable are in the 'src' folder.

src/ApplicationRunner.java

@@ -1,3 +1,7 @@
+/* Runner Class
+ * Contains main method for the application to run
+ * Use this to start the app
+*/
 public class ApplicationRunner {
     public static void main(String[] args) {
         new TextEditor();

src/MatchedGroup.java

@@ -1,17 +1,24 @@
+/* MatchedGroup Class
+ * Methods to return Start and End Indexes for given String
+*/
 public class MatchedGroup {
     private final int startIndex;
     private final int endIndex;
-
+
+    //Constructor to set indexes
     public MatchedGroup(int start, int end) {
         this.startIndex = start;
         this.endIndex = end;
     }
-
-    public int getEndIndex() {
-        return endIndex;
-    }
-
+
+    //Getter for StartIndex
     public int getStartIndex() {
         return startIndex;
     }
+
+    //Getter for EndIndex
+    public int getEndIndex() {
+        return endIndex;
+    }
+
 }

src/SearchCompleteHandler.java

@@ -1,5 +1,6 @@
 import java.util.List;
 
+//Handler interface for TextSearcher implementation
 public interface SearchCompleteHandler {
     void handle(List<MatchedGroup> result);
 }