From de302ae2db57ef22429cbe0374cd2080b3d780eb Mon Sep 17 00:00:00 2001 From: Sebastian Stenzel Date: Mon, 7 Mar 2022 09:35:11 +0100 Subject: [PATCH] javadoc --- .../integrations/autostart/AutoStartProvider.java | 6 ++++++ .../cryptomator/integrations/common/OperatingSystem.java | 2 ++ .../java/org/cryptomator/integrations/common/Priority.java | 2 ++ .../integrations/keychain/KeychainAccessProvider.java | 6 ++++++ .../integrations/uiappearance/UiAppearanceProvider.java | 6 ++++++ 5 files changed, 22 insertions(+) diff --git a/src/main/java/org/cryptomator/integrations/autostart/AutoStartProvider.java b/src/main/java/org/cryptomator/integrations/autostart/AutoStartProvider.java index 80bf638..49f6e3a 100644 --- a/src/main/java/org/cryptomator/integrations/autostart/AutoStartProvider.java +++ b/src/main/java/org/cryptomator/integrations/autostart/AutoStartProvider.java @@ -6,6 +6,12 @@ public interface AutoStartProvider { + /** + * Loads the best-suited AutoStartProvider. + * + * @return preferred AutoStartProvider (if any) + * @since 1.1.0 + */ static Optional get() { return IntegrationsLoader.load(AutoStartProvider.class); } diff --git a/src/main/java/org/cryptomator/integrations/common/OperatingSystem.java b/src/main/java/org/cryptomator/integrations/common/OperatingSystem.java index f618ac8..3369011 100644 --- a/src/main/java/org/cryptomator/integrations/common/OperatingSystem.java +++ b/src/main/java/org/cryptomator/integrations/common/OperatingSystem.java @@ -9,6 +9,8 @@ /** * Restricts the annotated integration provider to one or more operating system(s). + * + * @since 1.1.0 */ @Documented @Retention(RetentionPolicy.RUNTIME) diff --git a/src/main/java/org/cryptomator/integrations/common/Priority.java b/src/main/java/org/cryptomator/integrations/common/Priority.java index 8bb9a00..81ee75d 100644 --- a/src/main/java/org/cryptomator/integrations/common/Priority.java +++ b/src/main/java/org/cryptomator/integrations/common/Priority.java @@ -11,6 +11,8 @@ * Integration Priority. *

* If multiple implementations for an integration can be provided, the provider with the highest priority will be used. + * + * @since 1.1.0 */ @Documented @Retention(RetentionPolicy.RUNTIME) diff --git a/src/main/java/org/cryptomator/integrations/keychain/KeychainAccessProvider.java b/src/main/java/org/cryptomator/integrations/keychain/KeychainAccessProvider.java index 3a18d66..ef0cfae 100644 --- a/src/main/java/org/cryptomator/integrations/keychain/KeychainAccessProvider.java +++ b/src/main/java/org/cryptomator/integrations/keychain/KeychainAccessProvider.java @@ -9,6 +9,12 @@ */ public interface KeychainAccessProvider { + /** + * Loads all available KeychainAccessProvider. + * + * @return a stream of {@link #isSupported() supported} KeychainAccessProviders + * @since 1.1.0 + */ static Stream get() { return IntegrationsLoader.loadAll(KeychainAccessProvider.class).filter(KeychainAccessProvider::isSupported); } diff --git a/src/main/java/org/cryptomator/integrations/uiappearance/UiAppearanceProvider.java b/src/main/java/org/cryptomator/integrations/uiappearance/UiAppearanceProvider.java index 8dc0e7d..21e805c 100644 --- a/src/main/java/org/cryptomator/integrations/uiappearance/UiAppearanceProvider.java +++ b/src/main/java/org/cryptomator/integrations/uiappearance/UiAppearanceProvider.java @@ -9,6 +9,12 @@ */ public interface UiAppearanceProvider { + /** + * Loads the best-suited UiAppearanceProvider. + * + * @return preferred UiAppearanceProvider (if any) + * @since 1.1.0 + */ static Optional get() { return IntegrationsLoader.load(UiAppearanceProvider.class); }