Skip to content

refactor: Use addon class name if no meta annotation is present #41

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.

Sign up for GitHub

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

Merged
CrAfTsArMy merged 2 commits into from
Apr 6, 2026
Merged

refactor: Use addon class name if no meta annotation is present #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f7947c6
refactor: Deprecate mapped addon names
CrAfTsArMy Apr 6, 2026
f0ad442
refactor: Use addon class name as fallback
CrAfTsArMy Apr 6, 2026
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
17 changes: 14 additions & 3 deletions src/main/java/de/craftsblock/craftsnet/addon/meta/AddonConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,18 @@ public static AddonConfiguration of(Path path, Json json, URL[] classpath, Depen
* @throws IllegalStateException If the provided addon class is not annotated with {@link Meta}.
*/
public static List<AddonConfiguration> of(CraftsNet craftsNet, AddonLoader loader, Class<? extends Addon> addon) {
String name;
Meta meta = addon.getDeclaredAnnotation(Meta.class);
if (meta == null && !MAPPED_NAMES.containsKey(addon)) {
throw new IllegalStateException("The addon class " + addon.getName() + " is not annotated with @" + Meta.class.getSimpleName() + "!");
if (meta != null) {
name = meta.name();
} else if (MAPPED_NAMES.containsKey(addon)) {
name = MAPPED_NAMES.get(addon);
craftsNet.getLogger().warning("Deprecated: " + addon.getName() + " still uses a mapped addon name!");
} else {
name = addon.getSimpleName();
}

String name = MAPPED_NAMES.getOrDefault(addon, meta != null ? meta.name() : null);
ensureValidAddonName(name);
Depends depends = addon.getDeclaredAnnotation(Depends.class);

List<RegisteredService> services = new ArrayList<>();
Expand Down Expand Up @@ -198,8 +204,13 @@ public static String ensureValidAddonName(String name) {
*
* @param addon The addon class.
* @param name The name to associate with the addon class.
* @deprecated Addon classes will use the class name as it's mapped name
* if no {@link de.craftsblock.craftsnet.addon.meta.annotations.Meta} annotation is present.
* There will be no replacement as custom mapped names are no longer supported.
*/
@ApiStatus.Internal
@Deprecated(since = "3.7.2", forRemoval = true)
@ApiStatus.ScheduledForRemoval(inVersion = "3.8.0")
public static void map(Class<? extends Addon> addon, String name) {
MAPPED_NAMES.put(addon, name);
}
Expand Down
6 changes: 6 additions & 0 deletions src/main/java/de/craftsblock/craftsnet/builder/AddonContainingBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,13 @@ public AddonContainingBuilder(Collection<Class<? extends Addon>> addons) {
* @param type The addon class.
* @param name The name to associate with the addon class.
* @return The {@link AddonContainingBuilder} instance.
* @deprecated Addon classes will use the class name as it's mapped name
* if no {@link de.craftsblock.craftsnet.addon.meta.annotations.Meta} annotation is present.
* There will be no replacement as custom mapped names are no longer supported.
*/
@SuppressWarnings("removal")
@Deprecated(since = "3.7.2", forRemoval = true)
@ApiStatus.ScheduledForRemoval(inVersion = "3.8.0")
public AddonContainingBuilder map(Class<? extends Addon> type, String name) {
AddonConfiguration.map(type, name);
return this;
Expand Down
Loading