Interface PrefixedLoggerAdapter<P, B extends LogBuilderCore>

Type Parameters:
P - platform audience type (Player, ServerPlayerEntity, etc.)
B - log builder type
public interface PrefixedLoggerAdapter<P, B extends LogBuilderCore>
Shared adapter for prefixed logger wrappers.

  • Method Summary

    Modifier and Type
    Method
    Description
    B
    buildLogBuilder(LogLevel level)
    Creates a log builder for a log level.
    default B
    debug()
    Creates a DEBUG level builder.
    default B
    error()
    Creates an ERROR level builder.
    PrefixedLoggerCore
    getCore()
    Returns prefixed logger core.
    LoggerAdapter<P,?>
    getLoggerAdapter()
    Returns the parent logger adapter.
    default String
    getName()
    Returns prefixed logger name.
    default String
    getPrefix()
    Returns configured prefix.
    default B
    info()
    Creates an INFO level builder.
    default boolean
    isEnabled()
    Returns whether logger is enabled.
    default boolean
    isLevelEnabled(LogLevel level)
    Returns whether the supplied log level is enabled for this prefixed logger.
    default B
    log()
    Creates a builder for INFO level.
    default B
    noPrefix()
    Creates a builder with prefix disabled.
    default void
    send(LogLevel level, Object message)
    Sends a message using default target.
    default void
    send(LogLevel level, Object message, P player)
    Sends a message to a player.
    default void
    send(LogLevel level, Object message, P player, boolean all)
    Sends a message to a player, optionally broadcasting.
    default void
    sendToConsole(LogLevel level, Object message)
    Sends a message to console target.
    default void
    sendToPlayers(LogLevel level, Object message, @Nullable Collection<? extends P> players)
    Sends a message to a collection of players.
    default void
    setEnabled(boolean enabled)
    Enables or disables this logger.
    default B
    success()
    Creates a SUCCESS level builder.
    default B
    warn()
    Creates a WARN level builder.

  • Method Details

    • getCore

      PrefixedLoggerCore getCore()
      Returns prefixed logger core.
      Returns:
      core instance

    • getLoggerAdapter

      LoggerAdapter<P,?> getLoggerAdapter()
      Returns the parent logger adapter.
      Returns:
      logger adapter

    • buildLogBuilder

      B buildLogBuilder(LogLevel level)
      Creates a log builder for a log level.
      Parameters:
      level - log level
      Returns:
      log builder instance

    • getName

      default String getName()
      Returns prefixed logger name.
      Returns:
      logger name

    • getPrefix

      default String getPrefix()
      Returns configured prefix.
      Returns:
      prefix text

    • isEnabled

      default boolean isEnabled()
      Returns whether logger is enabled.
      Returns:
      true if enabled

    • isLevelEnabled

      default boolean isLevelEnabled(LogLevel level)
      Returns whether the supplied log level is enabled for this prefixed logger.
      Parameters:
      level - log level to check
      Returns:
      true when formatting and delivery should proceed

    • setEnabled

      default void setEnabled(boolean enabled)
      Enables or disables this logger.
      Parameters:
      enabled - true to enable

    • send

      default void send(LogLevel level, Object message)
      Sends a message using default target.
      Parameters:
      level - log level
      message - message to send

    • send

      default void send(LogLevel level, Object message, @Nullable P player)
      Sends a message to a player.
      Parameters:
      level - log level
      message - message to send
      player - target player

    • send

      default void send(LogLevel level, Object message, @Nullable P player, boolean all)
      Sends a message to a player, optionally broadcasting.
      Parameters:
      level - log level
      message - message to send
      player - target player
      all - whether to broadcast to all players

    • sendToConsole

      default void sendToConsole(LogLevel level, Object message)
      Sends a message to console target.
      Parameters:
      level - log level
      message - message to send

    • sendToPlayers

      default void sendToPlayers(LogLevel level, Object message, @Nullable @Nullable Collection<? extends P> players)
      Sends a message to a collection of players.
      Parameters:
      level - log level
      message - message to send
      players - target players

    • log

      default B log()
      Creates a builder for INFO level.
      Returns:
      log builder

    • noPrefix

      default B noPrefix()
      Creates a builder with prefix disabled.
      Returns:
      log builder

    • info

      default B info()
      Creates an INFO level builder.
      Returns:
      log builder

    • warn

      default B warn()
      Creates a WARN level builder.
      Returns:
      log builder

    • error

      default B error()
      Creates an ERROR level builder.
      Returns:
      log builder

    • debug

      default B debug()
      Creates a DEBUG level builder.
      Returns:
      log builder

    • success

      default B success()
      Creates a SUCCESS level builder.
      Returns:
      log builder