From 1f7b2ca85e4a322ea7cbbcf622e1b1458be7a138 Mon Sep 17 00:00:00 2001 From: Hammy Date: Tue, 27 Jul 2021 00:46:24 +0100 Subject: [PATCH] Add javadoc --- .../java/me/goudham/MacClipboardListener.java | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/src/main/java/me/goudham/MacClipboardListener.java b/src/main/java/me/goudham/MacClipboardListener.java index 8346d76..21a381d 100644 --- a/src/main/java/me/goudham/MacClipboardListener.java +++ b/src/main/java/me/goudham/MacClipboardListener.java @@ -15,6 +15,12 @@ class MacClipboardListener extends ClipboardListener { MacClipboardListener() { } + /** + * Checks if {@link String} is within the clipboard and changed + * + * @param newClipboardContents {@link Transferable} containing new clipboard contents + * @param myClipboardContents {@link MyClipboardContent[]} of Unknown {@link Class} containing previous contents + */ void checkText(Transferable newClipboardContents, MyClipboardContent[] myClipboardContents) { if (isTextMonitored()) { if (STRING.isAvailable(clipboard)) { @@ -28,6 +34,12 @@ class MacClipboardListener extends ClipboardListener { } } + /** + * Checks if {@link java.awt.Image} is within the clipboard and changed + * + * @param newClipboardContents {@link Transferable} containing new clipboard contents + * @param myClipboardContents {@link MyClipboardContent[]} of Unknown {@link Class} containing previous contents + */ void checkImages(Transferable newClipboardContents, MyClipboardContent[] myClipboardContents) { if (isImagesMonitored()) { if (IMAGE.isAvailable(clipboard)) { @@ -41,7 +53,10 @@ class MacClipboardListener extends ClipboardListener { } } - + /** + * Main entry point for {@link MacClipboardListener} + *

Retrieves thread from {@link Executors#newSingleThreadScheduledExecutor()} and executes code on a fixed delay

+ */ @Override void execute() { Transferable oldClipboardContents = clipboard.getContents(null);