-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
213 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
25 changes: 25 additions & 0 deletions
25
src/main/java/org/cryptomator/integrations/common/DisplayName.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| package org.cryptomator.integrations.common; | ||
|
|
||
| import org.jetbrains.annotations.ApiStatus; | ||
|
|
||
| import java.lang.annotation.Documented; | ||
| import java.lang.annotation.ElementType; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.RetentionPolicy; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| /** | ||
| * A humanreadable name of the annotated class. | ||
| * <p> | ||
| * Checked in the default implementation of the {@link NamedServiceProvider#getName()} with lower priority. | ||
| * | ||
| * @see NamedServiceProvider | ||
| * @see LocalizedDisplayName | ||
| */ | ||
| @Documented | ||
| @Retention(RetentionPolicy.RUNTIME) | ||
| @Target(ElementType.TYPE) | ||
| @ApiStatus.Experimental | ||
| public @interface DisplayName { | ||
| String value(); | ||
| } |
39 changes: 39 additions & 0 deletions
39
src/main/java/org/cryptomator/integrations/common/LocalizedDisplayName.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| package org.cryptomator.integrations.common; | ||
|
|
||
| import org.jetbrains.annotations.ApiStatus; | ||
|
|
||
| import java.lang.annotation.Documented; | ||
| import java.lang.annotation.ElementType; | ||
| import java.lang.annotation.Retention; | ||
| import java.lang.annotation.RetentionPolicy; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| /** | ||
| * A humanreadable, localized name of the annotated class. | ||
| * <p> | ||
| * Checked in the default implementation of the {@link NamedServiceProvider#getName()} with highest priority. | ||
| * | ||
| * @see NamedServiceProvider | ||
| * @see DisplayName | ||
| */ | ||
| @Documented | ||
| @Retention(RetentionPolicy.RUNTIME) | ||
| @Target(ElementType.TYPE) | ||
| @ApiStatus.Experimental | ||
| public @interface LocalizedDisplayName { | ||
|
|
||
| /** | ||
| * Name of the localization bundle, where the display name is loaded from. | ||
| * | ||
| * @return Name of the localization bundle | ||
| */ | ||
| String bundle(); | ||
|
|
||
| /** | ||
| * The localization key containing the display name. | ||
| * | ||
| * @return Localization key to use | ||
| */ | ||
| String key(); | ||
|
|
||
| } |
41 changes: 41 additions & 0 deletions
41
src/main/java/org/cryptomator/integrations/common/NamedServiceProvider.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| package org.cryptomator.integrations.common; | ||
|
|
||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import java.util.MissingResourceException; | ||
| import java.util.ResourceBundle; | ||
|
|
||
| /** | ||
| * A service provider with a human-readable, possibly localized name. | ||
| */ | ||
| public interface NamedServiceProvider { | ||
|
|
||
| /** | ||
| * Get the name of this service provider. | ||
| * | ||
| * @return The name of the service provider | ||
| * @implNote The default implementation looks first for a {@link LocalizedDisplayName} and loads the name from the specified resource bundle/key. If the annotation is not present or loading the resource throws an exception, the code looks for {@link DisplayName} and uses its value. If none of the former annotations are present, it falls back to the qualified class name. | ||
| * @see DisplayName | ||
| * @see LocalizedDisplayName | ||
| */ | ||
| default String getName() { | ||
| var localizedDisplayName = this.getClass().getAnnotation(LocalizedDisplayName.class); | ||
| if (localizedDisplayName != null) { | ||
| try { | ||
| return ResourceBundle.getBundle(localizedDisplayName.bundle()) // | ||
| .getString(localizedDisplayName.key()); | ||
| } catch (MissingResourceException e) { | ||
| var clazz = this.getClass(); | ||
| var logger = LoggerFactory.getLogger(clazz); | ||
| logger.warn("Failed to load localized display name for {}. Falling back to not-localized display name/class name.", clazz.getName(), e); | ||
| } | ||
| } | ||
|
|
||
| var displayName = this.getClass().getAnnotation(DisplayName.class); | ||
| if (displayName != null) { | ||
| return displayName.value(); | ||
| } else { | ||
| return this.getClass().getName(); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
56 changes: 56 additions & 0 deletions
56
src/main/java/org/cryptomator/integrations/quickaccess/QuickAccessService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| package org.cryptomator.integrations.quickaccess; | ||
|
|
||
| import org.cryptomator.integrations.common.IntegrationsLoader; | ||
| import org.cryptomator.integrations.common.NamedServiceProvider; | ||
| import org.jetbrains.annotations.Blocking; | ||
| import org.jetbrains.annotations.NotNull; | ||
|
|
||
| import java.nio.file.Path; | ||
| import java.util.stream.Stream; | ||
|
|
||
| /** | ||
| * Service adding a system path link to a quick access area of the OS or an application (e.g. file manager). | ||
| * | ||
| * @apiNote On purpose this service does not define, what an "link to a quick access area" is. The defintion depends on the OS. For example, the quick access area can be the home screen/desktop and the link would be an icon leading to the linked path. | ||
| */ | ||
| @FunctionalInterface | ||
| public interface QuickAccessService extends NamedServiceProvider { | ||
|
|
||
| /** | ||
| * Creates an entry in the quick access area. | ||
| * | ||
| * @param target The filesystem path the quick access entry points to | ||
| * @param displayName The display name of the quick access entry | ||
| * @return a {@link QuickAccessEntry }, used to remove the entry again | ||
| * @throws QuickAccessServiceException if adding an entry to the quick access area fails | ||
| * @apiNote It depends on the service implementation wether the display name is used or not. | ||
| */ | ||
| @Blocking | ||
| QuickAccessEntry add(@NotNull Path target, @NotNull String displayName) throws QuickAccessServiceException; | ||
|
|
||
| /** | ||
| * An entry of the quick access area, created by a service implementation. | ||
| */ | ||
| @FunctionalInterface | ||
| interface QuickAccessEntry { | ||
|
|
||
| /** | ||
| * Removes this entry from the quick access area. | ||
| * | ||
| * @throws QuickAccessServiceException if removal fails. | ||
| * @implSpec Service implementations 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. | ||
| */ | ||
| @Blocking | ||
| void remove() throws QuickAccessServiceException; | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Loads all supported service providers. | ||
| * | ||
| * @return Stream of supported {@link QuickAccessService} implementations (may be empty) | ||
| */ | ||
| static Stream<QuickAccessService> get() { | ||
| return IntegrationsLoader.loadAll(QuickAccessService.class); | ||
| } | ||
| } |
12 changes: 12 additions & 0 deletions
12
src/main/java/org/cryptomator/integrations/quickaccess/QuickAccessServiceException.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| package org.cryptomator.integrations.quickaccess; | ||
|
|
||
| public class QuickAccessServiceException extends Exception { | ||
|
|
||
| public QuickAccessServiceException(String message) { | ||
| super(message); | ||
| } | ||
|
|
||
| public QuickAccessServiceException(String message, Throwable t) { | ||
| super(message, t); | ||
| } | ||
| } |