refined API

Author: infeo

src/main/java/module-info.java

@@ -1,4 +1,4 @@
-import org.cryptomator.integrations.filemanagersidebar.SidebarService;
+import org.cryptomator.integrations.sidebar.SidebarService;
 import org.cryptomator.integrations.mount.MountService;
 import org.cryptomator.integrations.revealpath.RevealPathService;
 import org.cryptomator.integrations.tray.TrayMenuController;
@@ -19,7 +19,7 @@
 	exports org.cryptomator.integrations.revealpath;
 	exports org.cryptomator.integrations.tray;
 	exports org.cryptomator.integrations.uiappearance;
-	exports org.cryptomator.integrations.filemanagersidebar;
+	exports org.cryptomator.integrations.sidebar;
 
 	uses AutoStartProvider;
 	uses KeychainAccessProvider;

…s/filemanagersidebar/SidebarService.java …integrations/sidebar/SidebarService.javasrc/main/java/org/cryptomator/integrations/filemanagersidebar/SidebarService.java renamed to src/main/java/org/cryptomator/integrations/sidebar/SidebarService.java src/main/java/org/cryptomator/integrations/filemanagersidebar/SidebarService.java renamed to src/main/java/org/cryptomator/integrations/sidebar/SidebarService.java

@@ -1,9 +1,9 @@
-package org.cryptomator.integrations.filemanagersidebar;
+package org.cryptomator.integrations.sidebar;
 
 import org.cryptomator.integrations.common.IntegrationsLoader;
+import org.jetbrains.annotations.Blocking;
 import org.jetbrains.annotations.NotNull;
 
-import java.io.Closeable;
 import java.nio.file.Path;
 import java.util.Optional;
 
@@ -15,11 +15,13 @@ public interface SidebarService {
 	/**
 	 * Creates an entry in the filemanager sidebar.
 	 *
+	 * @param target      The filesystem path the sidebar entry points to
 	 * @param displayName The display name of the sidebar entry
-	 * @param target      The filesystem path the sidebar entry points to.
-	 * @return a @{link SidebarEntry } object, used to remove the entry again
-	 * @apiNote Depending on the implemenation, the display name may not be used.
+	 * @return a {@link SidebarEntry }, used to remove the entry again
+	 * @throws SidebarServiceException if adding an entry to the filemanager sidebar fails
+	 * @apiNote It depends on the service implementation wether the display name is used or not.
 	 */
+	@Blocking
 	SidebarEntry add(@NotNull Path target, @NotNull String displayName) throws SidebarServiceException;
 
 	/**
@@ -28,9 +30,13 @@ public interface SidebarService {
 	interface SidebarEntry {
 
 		/**
-		 * Removes this entry from the sidebar. Once removed, this object cannot be added again.
+		 * Removes this entry from the sidebar.
+		 *
+		 * @throws SidebarServiceException if removal fails.
+		 * @implSpec ServiceProviders should make this function <em>idempotent</em>, i.e. after the method is called once and succeeded, consecutive calls should not change anything or throw an error.
 		 */
-		void remove();
+		@Blocking
+		void remove() throws SidebarServiceException;
 
 	}
 

…agersidebar/SidebarServiceException.java …ons/sidebar/SidebarServiceException.javasrc/main/java/org/cryptomator/integrations/filemanagersidebar/SidebarServiceException.java renamed to src/main/java/org/cryptomator/integrations/sidebar/SidebarServiceException.java src/main/java/org/cryptomator/integrations/filemanagersidebar/SidebarServiceException.java renamed to src/main/java/org/cryptomator/integrations/sidebar/SidebarServiceException.java

@@ -1,4 +1,4 @@
-package org.cryptomator.integrations.filemanagersidebar;
+package org.cryptomator.integrations.sidebar;
 
 public class SidebarServiceException extends Exception {