Interface ComponentLoggingEventBuilder

All Superinterfaces:
org.slf4j.spi.LoggingEventBuilder
public interface ComponentLoggingEventBuilder extends org.slf4j.spi.LoggingEventBuilder
A builder for logging events that accepts Component messages and arguments.
Since:
5.0.0

  • Method Details

    • setCause

      @CheckReturnValue ComponentLoggingEventBuilder setCause(@Nullable Throwable cause)
      Specified by:
      setCause in interface org.slf4j.spi.LoggingEventBuilder

    • addMarker

      @CheckReturnValue ComponentLoggingEventBuilder addMarker(org.slf4j.Marker marker)
      Specified by:
      addMarker in interface org.slf4j.spi.LoggingEventBuilder

    • addArgument

      @CheckReturnValue ComponentLoggingEventBuilder addArgument(@Nullable Object p)
      Specified by:
      addArgument in interface org.slf4j.spi.LoggingEventBuilder

    • addArgument

      @CheckReturnValue ComponentLoggingEventBuilder addArgument(@Nullable Supplier<?> objectSupplier)
      Specified by:
      addArgument in interface org.slf4j.spi.LoggingEventBuilder

    • addKeyValue

      @CheckReturnValue ComponentLoggingEventBuilder addKeyValue(@Nullable String key, @Nullable Object value)
      Specified by:
      addKeyValue in interface org.slf4j.spi.LoggingEventBuilder

    • addKeyValue

      @CheckReturnValue ComponentLoggingEventBuilder addKeyValue(@Nullable String key, Supplier<Object> valueSupplier)
      Specified by:
      addKeyValue in interface org.slf4j.spi.LoggingEventBuilder

    • setMessage

      @CheckReturnValue ComponentLoggingEventBuilder setMessage(@Nullable String message)
      Specified by:
      setMessage in interface org.slf4j.spi.LoggingEventBuilder

    • setMessage

      @CheckReturnValue ComponentLoggingEventBuilder setMessage(@Nullable ComponentLike message)
      Set the message to be logged for this event.
      Parameters:
      message - the message
      Returns:
      this builder
      Since:
      5.0.0

    • setMessage

      @CheckReturnValue ComponentLoggingEventBuilder setMessage(Supplier<@Nullable String> messageSupplier)
      Specified by:
      setMessage in interface org.slf4j.spi.LoggingEventBuilder

    • setComponentMessage

      @CheckReturnValue ComponentLoggingEventBuilder setComponentMessage(Supplier<? extends @Nullable ComponentLike> messageSupplier)
      Set the message supplier to be logged for this event.
      Parameters:
      messageSupplier - the message supplier
      Returns:
      this builder
      Since:
      5.0.0

    • log

      void log(@Nullable ComponentLike message)
      Set the message and publish this logging event.
      Parameters:
      message - the message
      Since:
      5.0.0
      See Also:
      • LoggingEventBuilder.log()

    • log

      void log(@Nullable ComponentLike message, @Nullable Object arg)
      Set the message with one argument and publish this logging event.
      Parameters:
      message - the message
      arg - the argument
      Since:
      5.0.0
      See Also:
      • LoggingEventBuilder.log()

    • log

      void log(@Nullable ComponentLike message, @Nullable Object arg0, @Nullable Object arg1)
      Set the message with two arguments and publish this logging event.
      Parameters:
      message - the message
      arg0 - the first argument
      arg1 - the second argument
      Since:
      5.0.0
      See Also:
      • LoggingEventBuilder.log()

    • log

      void log(@Nullable ComponentLike message, @Nullable Object... args)
      Set the message with an array of arguments and publish this logging event.
      Parameters:
      message - the message
      args - the arguments
      Since:
      5.0.0
      See Also:
      • LoggingEventBuilder.log()

    • logComponent

      void logComponent(Supplier<? extends @Nullable ComponentLike> messageSupplier)
      Set the message supplier and publish this logging event.
      Parameters:
      messageSupplier - the message supplier
      Since:
      5.0.0
      See Also:
      • LoggingEventBuilder.log()