Add javadocs

src/main/java/me/goudham/ClipboardListener.java

@@ -8,6 +8,10 @@ import java.util.List;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * Abstract class containing common operations between {@link WindowsOrUnixClipboardListener} and
+ * {@link MacClipboardListener}
+ */
 abstract class ClipboardListener {
     Clipboard clipboard;
     Logger logger;
@@ -105,14 +109,23 @@ abstract class ClipboardListener {
      */
     abstract void insertAndNotify(List<File> fileContent);
 
+    /**
+     * Toggles the current value of text monitoring, the default value is set to {@code True}
+     */
     void toggleTextMonitored() {
         this.textMonitored = !textMonitored;
     }
 
+    /**
+     * Toggles the current value of image monitoring, the default value is set to {@code True}
+     */
     void toggleImagesMonitored() {
         this.imageMonitored = !imageMonitored;
     }
 
+    /**
+     * Toggles the current value of file monitoring, the default value is set to {@code True}
+     */
     void toggleFileMonitored() {
         this.fileMonitored = !fileMonitored;
     }

src/main/java/me/goudham/MacClipboardListener.java

@@ -19,6 +19,9 @@ import static me.goudham.Contents.FILE;
 import static me.goudham.Contents.IMAGE;
 import static me.goudham.Contents.TEXT;
 
+/**
+ * Clipboard Listener for the macOS operating system
+ */
 class MacClipboardListener extends ClipboardListener implements Runnable {
     ScheduledExecutorService scheduledExecutorService = Executors.newSingleThreadScheduledExecutor();
     GenericClipboardContent<?>[] genericClipboardContents;

src/main/java/me/goudham/MyClipboard.java

@@ -68,26 +68,80 @@ public class MyClipboard {
         clipboardListener.stopListening();
     }
 
+    /**
+     * Insert the given {@link String} into the system clipboard
+     * <p>
+     * Due to the underlying {@link MacClipboardListener#insert(String)} implementation, inserting
+     * clipboard contents will always result in event notifications being sent
+     *
+     * @param stringContent The given {@link String} to insert
+     * @see WindowsOrUnixClipboardListener#insert(String)
+     * @see MacClipboardListener#insert(String)
+     */
     public void insert(String stringContent) {
         clipboardListener.insert(stringContent);
     }
 
+    /**
+     * Insert the given {@link Image} into the system clipboard
+     * <p>
+     * Due to the underlying {@link MacClipboardListener#insert(Image)} implementation, inserting
+     * clipboard contents will always result in event notifications being sent
+     *
+     * @param imageContent The given {@link Image} to insert
+     * @see WindowsOrUnixClipboardListener#insert(Image)
+     * @see MacClipboardListener#insert(Image)
+     */
     public void insert(Image imageContent) {
         clipboardListener.insert(imageContent);
     }
 
+    /**
+     * Insert the given {@link List} of {@link File} into the system clipboard
+     * <p>
+     * Due to the underlying {@link MacClipboardListener#insert(List)} implementation, inserting
+     * clipboard contents will always result in event notifications being sent
+     *
+     * @param fileContent The given {@link List} of {@link File} to insert
+     * @see WindowsOrUnixClipboardListener#insert(List)
+     * @see MacClipboardListener#insert(List)
+     */
     public void insert(List<File> fileContent) {
         clipboardListener.insert(fileContent);
     }
 
+    /**
+     * Insert the given {@link String} into the system clipboard
+     * and notify the user about the new contents within the clipboard
+     *
+     * @param stringContent The given {@link String} to insert
+     * @see WindowsOrUnixClipboardListener#insertAndNotify(String)
+     * @see MacClipboardListener#insertAndNotify(String)
+     */
     public void insertAndNotify(String stringContent) {
         clipboardListener.insertAndNotify(stringContent);
     }
 
+    /**
+     * Insert the given {@link Image} into the system clipboard
+     * and notify the user about the new contents within the clipboard
+     *
+     * @param imageContent The given {@link Image} to insert
+     * @see WindowsOrUnixClipboardListener#insertAndNotify(Image)
+     * @see MacClipboardListener#insertAndNotify(Image)
+     */
     public void insertAndNotify(Image imageContent) {
         clipboardListener.insertAndNotify(imageContent);
     }
 
+    /**
+     * Insert the given {@link List} of {@link File} into the system clipboard
+     * and notify the user about the new contents within the clipboard
+     *
+     * @param fileContent The given {@link List} of {@link File} to insert
+     * @see WindowsOrUnixClipboardListener#insertAndNotify(List)
+     * @see MacClipboardListener#insertAndNotify(List)
+     */
     public void insertAndNotify(List<File> fileContent) {
         clipboardListener.insertAndNotify(fileContent);
     }
@@ -152,14 +206,29 @@ public class MyClipboard {
         clipboardListener.getEventManager().removeEventListener(fileEvent);
     }
 
+    /**
+     * Toggles the current value of text monitoring, the default value is set to {@code True}
+     *
+     * @see ClipboardListener#toggleTextMonitored()
+     */
     public void toggleTextMonitored() {
         clipboardListener.toggleTextMonitored();
     }
 
+    /**
+     * Toggles the current value of image monitoring, the default value is set to {@code True}
+     *
+     * @see ClipboardListener#toggleImagesMonitored()
+     */
     public void toggleImagesMonitored() {
         clipboardListener.toggleImagesMonitored();
     }
 
+    /**
+     * Toggles the current value of file monitoring, the default value is set to {@code True}
+     *
+     * @see ClipboardListener#toggleFileMonitored()
+     */
     public void toggleFilesMonitored() {
         clipboardListener.toggleFileMonitored();
     }
@@ -196,11 +265,11 @@ public class MyClipboard {
         this.clipboardListener = clipboardListener;
     }
 
-    protected static SystemUtils getSystemUtils() {
+    static SystemUtils getSystemUtils() {
         return systemUtils;
     }
 
-    protected static void setSystemUtils(SystemUtils systemUtils) {
+    static void setSystemUtils(SystemUtils systemUtils) {
         MyClipboard.systemUtils = systemUtils;
     }
 }

src/main/java/me/goudham/WindowsOrUnixClipboardListener.java

@@ -19,6 +19,9 @@ import static me.goudham.Contents.FILE;
 import static me.goudham.Contents.IMAGE;
 import static me.goudham.Contents.TEXT;
 
+/**
+ * Clipboard Listener for Windows and Unix operating systems
+ */
 class WindowsOrUnixClipboardListener extends ClipboardListener implements Runnable, ClipboardOwner {
     private ExecutorService executorService = Executors.newSingleThreadExecutor();
     private boolean listening = false;