Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Add interface for display name #39

Merged
merged 5 commits into from
Jul 12, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions src/main/java/org/cryptomator/integrations/common/DisplayName.java
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();
}
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();

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
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());
logger.debug("Reason for failure of {}.", clazz.getName(), e);
}
}

var displayName = this.getClass().getAnnotation(DisplayName.class);
if (displayName != null) {
return displayName.value();
} else {
return this.getClass().getName();
}
}
}