Package net.kyori.adventure.platform.facet

Class Knob

java.lang.Object

net.kyori.adventure.platform.facet.Knob

public final class Knob
extends 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 BiConsumer<String,Throwable>	ERR
static Consumer<String>	OUT

Method Summary

Modifier and Type	Method	Description
static boolean	isEnabled(@NotNull String key, boolean defaultValue)	Gets whether a facet should be enabled.
static void	logError(@Nullable Throwable error, @NotNull String format, @NotNull Object... arguments)	Logs an error.
static void	logMessage(@NotNull String format, @NotNull Object... arguments)	Logs a message.
static void	logUnsupported(@NotNull Object facet, @NotNull 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 Consumer<String> OUT

ERR

public static volatile BiConsumer<String,Throwable> ERR

Method Detail

isEnabled

public static boolean isEnabled(@NotNull
                                @NotNull 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 Throwable error,
                            @NotNull
                            @NotNull String format,
                            @NotNull
                            @NotNull 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 String format,
                              @NotNull
                              @NotNull 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 Object facet,
                                  @NotNull
                                  @NotNull Object value)

Logs an unsupported value.

Parameters:

facet - a facet

value - a value

Since:

4.0.0