com.datastax.oss.dsbulk.executor.api.listener

Interface LogSink

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface LogSink

A sink for log messages.

This interface is intended to act as a tiny wrapper around calls to the underlying logging subsystem.

A typical implementation is:

 Logger logger = LoggerFactory.getLogger(...);
 LogSink sink = new LogSink() {

       public boolean isEnabled() {
         return logger.isInfoEnabled();
       }

       public void accept(String message, Object... args) {
         logger.info(message, args);
       }
     };
 

Method Summary

Modifier and Type	Method and Description
void	accept(String message, Object... args) Process the given message by (possibly) logging it.
static LogSink	buildFrom(Supplier<Boolean> enablementSupplier, BiConsumer<String,Object[]> messageConsumer) Creates a new sink with the given enablement supplier and given message consumer.
default boolean	isEnabled() Whether the sink will effectively process the message (i.e., log it) or not.

Method Detail

buildFrom

static LogSink buildFrom(Supplier<Boolean> enablementSupplier,
                         BiConsumer<String,Object[]> messageConsumer)

Creates a new sink with the given enablement supplier and given message consumer.

A typical invocation of this method is:

 Logger logger = LoggerFactory.getLogger(...);
 LogSink sink = LogSink.buildFrom(logger::isInfoEnabled, logger::info);
 

Parameters:

enablementSupplier - an enablement supplier.

messageConsumer - a message consumer.

Returns:

a newly-allocated sink.

isEnabled

default boolean isEnabled()

Whether the sink will effectively process the message (i.e., log it) or not.

Returns:

true if the sink will process the message, false if it will reject it.

accept

void accept(String message,
            Object... args)

Process the given message by (possibly) logging it.

Parameters:

message - The message to process.

args - The (optional) message arguments.