From 5b05aa75759966e71219167108cfca7ea0761a61 Mon Sep 17 00:00:00 2001 From: Philipp <62473021+CrAfTsArMy@users.noreply.github.com> Date: Mon, 6 Apr 2026 14:45:38 +0200 Subject: [PATCH] chore: Add the print format annotation --- .../craftsblock/craftsnet/logging/Logger.java | 18 ++++++++++-------- .../craftsnet/logging/impl/LoggerImpl.java | 2 +- .../craftsnet/logging/impl/NoOpLogger.java | 2 +- .../craftsnet/logging/impl/PlainLogger.java | 2 +- 4 files changed, 13 insertions(+), 11 deletions(-) diff --git a/src/main/java/de/craftsblock/craftsnet/logging/Logger.java b/src/main/java/de/craftsblock/craftsnet/logging/Logger.java index e8ca9406..12af8b68 100644 --- a/src/main/java/de/craftsblock/craftsnet/logging/Logger.java +++ b/src/main/java/de/craftsblock/craftsnet/logging/Logger.java @@ -1,5 +1,6 @@ package de.craftsblock.craftsnet.logging; +import org.intellij.lang.annotations.PrintFormat; import org.jetbrains.annotations.ApiStatus; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; @@ -32,7 +33,7 @@ public interface Logger { * @param args Arguments referenced by the format specifiers in the format string. * @since 3.5.2 */ - default void info(@NotNull String format, Object... args) { + default void info(@NotNull @PrintFormat String format, Object @Nullable ... args) { info(format(format, args)); } @@ -53,7 +54,7 @@ default void info(@NotNull String format, Object... args) { * @param args Arguments referenced by the format specifiers in the format string. * @since 3.5.2 */ - default void warning(@NotNull String format, Object... args) { + default void warning(@NotNull @PrintFormat String format, Object @Nullable ... args) { warning(format(format, args)); } @@ -74,7 +75,7 @@ default void warning(@NotNull String format, Object... args) { * @param args Arguments referenced by the format specifiers in the format string. * @since 3.5.2 */ - default void error(@NotNull String format, Object... args) { + default void error(@NotNull @PrintFormat String format, Object @Nullable ... args) { error(format(format, args)); } @@ -121,7 +122,8 @@ default void error(@NotNull Throwable throwable, @Nullable String comment) { * @param args Arguments referenced by the format specifiers in the format string. * @since 3.5.2 */ - default void error(@NotNull String format, @NotNull Throwable throwable, Object... args) { + default void error(@NotNull @PrintFormat String format, @NotNull Throwable throwable, + Object @Nullable ... args) { error(format(format, args), throwable); } @@ -142,7 +144,7 @@ default void error(@NotNull String format, @NotNull Throwable throwable, Object. * @param args Arguments referenced by the format specifiers in the format string. * @since 3.5.2 */ - default void debug(@NotNull String format, Object... args) { + default void debug(@NotNull @PrintFormat String format, Object @Nullable ... args) { debug(format(format, args)); } @@ -152,7 +154,7 @@ default void debug(@NotNull String format, Object... args) { * @param name The name for the cloned logger. * @return A new {@code Logger} instance cloned from this logger with the given name. */ - Logger cloneWithName(String name); + Logger cloneWithName(@Nullable String name); /** * Creates a clone of this {@link Logger} with a formatted name. @@ -166,7 +168,7 @@ default void debug(@NotNull String format, Object... args) { * @return A new {@code Logger} instance cloned from this logger with the formatted name. * @since 3.5.2 */ - default Logger cloneWithName(String format, Object... args) { + default Logger cloneWithName(@NotNull @PrintFormat String format, Object @Nullable ... args) { return cloneWithName(format(format, args)); } @@ -180,7 +182,7 @@ default Logger cloneWithName(String format, Object... args) { * @return A formatted string. * @since 3.5.2 */ - default String format(@NotNull String format, Object... args) { + default String format(@NotNull @PrintFormat String format, Object @Nullable ... args) { return String.format(format, args); } diff --git a/src/main/java/de/craftsblock/craftsnet/logging/impl/LoggerImpl.java b/src/main/java/de/craftsblock/craftsnet/logging/impl/LoggerImpl.java index 277671b1..c4bbdd2c 100644 --- a/src/main/java/de/craftsblock/craftsnet/logging/impl/LoggerImpl.java +++ b/src/main/java/de/craftsblock/craftsnet/logging/impl/LoggerImpl.java @@ -121,7 +121,7 @@ public void debug(@Nullable String text) { * @return {@inheritDoc} */ @Override - public Logger cloneWithName(String name) { + public Logger cloneWithName(@Nullable String name) { return new LoggerImpl(this.debug, name); } diff --git a/src/main/java/de/craftsblock/craftsnet/logging/impl/NoOpLogger.java b/src/main/java/de/craftsblock/craftsnet/logging/impl/NoOpLogger.java index 62777495..fbd90dc8 100644 --- a/src/main/java/de/craftsblock/craftsnet/logging/impl/NoOpLogger.java +++ b/src/main/java/de/craftsblock/craftsnet/logging/impl/NoOpLogger.java @@ -91,7 +91,7 @@ public void debug(@Nullable String text) { * @return {@inheritDoc} */ @Override - public Logger cloneWithName(String name) { + public Logger cloneWithName(@Nullable String name) { return this; } diff --git a/src/main/java/de/craftsblock/craftsnet/logging/impl/PlainLogger.java b/src/main/java/de/craftsblock/craftsnet/logging/impl/PlainLogger.java index 6ab4b71a..cabbb5fc 100644 --- a/src/main/java/de/craftsblock/craftsnet/logging/impl/PlainLogger.java +++ b/src/main/java/de/craftsblock/craftsnet/logging/impl/PlainLogger.java @@ -103,7 +103,7 @@ public void debug(@Nullable String text) { * @return {@inheritDoc} */ @Override - public Logger cloneWithName(String name) { + public Logger cloneWithName(@Nullable String name) { return this; }