api fine tuning and documentation

Author: overheadhunter

src/main/java/org/cryptomator/integrations/tray/TrayIntegrationProvider.java

@@ -4,8 +4,17 @@
 
 import java.util.Optional;
 
+/**
+ * Allows to perform OS-specific tasks when the app gets minimized to or restored from a tray icon.
+ */
 public interface TrayIntegrationProvider {
 
+	/**
+	 * Loads the best-suited TrayIntegrationProvider.
+	 *
+	 * @return preferred TrayIntegrationProvider (if any)
+	 * @since 1.1.0
+	 */
 	static Optional<TrayIntegrationProvider> get() {
 		return IntegrationsLoader.load(TrayIntegrationProvider.class);
 	}

src/main/java/org/cryptomator/integrations/tray/TrayMenuController.java

@@ -7,26 +7,34 @@
 import java.util.List;
 import java.util.Optional;
 
+/**
+ * Displays a tray icon and menu
+ *
+ * @since 1.1.0
+ */
 public interface TrayMenuController {
 
 	static Optional<TrayMenuController> get() {
 		return IntegrationsLoader.load(TrayMenuController.class);
 	}
 
 	/**
-	 * Adds an icon to the system tray.
+	 * Displays an icon on the system tray.
 	 *
-	 * @param iconData What image to show
-	 * @param tooltip  Text shown when hovering
-	 * @throws IOException thrown when interacting with the given <code>iconData</code>
+	 * @param rawImageData  What image to show
+	 * @param defaultAction Action to perform when interacting with the icon directly instead of its menu
+	 * @param tooltip       Text shown when hovering
+	 * @throws IOException thrown when interacting with the given <code>rawImageData</code>
 	 */
-	void showTrayIcon(InputStream iconData, String tooltip) throws IOException;
+	void showTrayIcon(InputStream rawImageData, Runnable defaultAction, String tooltip) throws IOException;
 
 	/**
 	 * Show the given options in the tray menu.
+	 * <p>
+	 * This method may be called multiple times, e.g. when the vault list changes.
 	 *
 	 * @param items Menu items
 	 */
-	void setTrayMenu(List<TrayMenuItem> items);
+	void updateTrayMenu(List<TrayMenuItem> items);
 
 }