Package net.kyori.adventure.platform.facet

Class Knob

  • public final class Knob
extends java.lang.Object
    Facet utilities and logging pipeline.

    This is not supported API. Subject to change at any time.

    Since:
    4.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static boolean DEBUG  
      static java.util.function.BiConsumer<java.lang.String,​java.lang.Throwable> ERR  
      static java.util.function.Consumer<java.lang.String> OUT  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean isEnabled​(@NotNull java.lang.String key, boolean defaultValue)
      Gets whether a facet should be enabled.
      static void logError​(@Nullable java.lang.Throwable error, @NotNull java.lang.String format, @NotNull java.lang.Object... arguments)
      Logs an error.
      static void logMessage​(@NotNull java.lang.String format, @NotNull java.lang.Object... arguments)
      Logs a message.
      static void logUnsupported​(@NotNull java.lang.Object facet, @NotNull java.lang.Object value)
      Logs an unsupported value.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • DEBUG

        public static final boolean DEBUG

      • OUT

        public static volatile java.util.function.Consumer<java.lang.String> OUT

      • ERR

        public static volatile java.util.function.BiConsumer<java.lang.String,​java.lang.Throwable> ERR

    • Method Detail

      • isEnabled

        public static boolean isEnabled​(@NotNull
                                @NotNull java.lang.String key,
                                boolean defaultValue)
        Gets whether a facet should be enabled.

        Use the JVM flag, -Dnet.kyori.adventure.<key>=true, to enable the facet.

        Parameters:
        key - a key
        defaultValue - the default value
        Returns:
        if the feature is enabled
        Since:
        4.0.0

      • logError

        public static void logError​(@Nullable
                            @Nullable java.lang.Throwable error,
                            @NotNull
                            @NotNull java.lang.String format,
                            @NotNull
                            @NotNull java.lang.Object... arguments)
        Logs an error.
        Parameters:
        error - an error
        format - a string format
        arguments - an array of arguments
        Since:
        4.0.0

      • logMessage

        public static void logMessage​(@NotNull
                              @NotNull java.lang.String format,
                              @NotNull
                              @NotNull java.lang.Object... arguments)
        Logs a message.
        Parameters:
        format - a string format
        arguments - an array of arguments
        Since:
        4.0.0

      • logUnsupported

        public static void logUnsupported​(@NotNull
                                  @NotNull java.lang.Object facet,
                                  @NotNull
                                  @NotNull java.lang.Object value)
        Logs an unsupported value.
        Parameters:
        facet - a facet
        value - a value
        Since:
        4.0.0