org.apache.kafka.common

Interface MessageFormatter

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, Configurable

public interface MessageFormatter
extends Configurable, java.io.Closeable

This interface allows to define Formatters that can be used to parse and format records read by a Consumer instance for display. The kafka-console-consumer has built-in support for MessageFormatter, via the --formatter flag. Kafka provides a few implementations to display records of internal topics such as __consumer_offsets, __transaction_state and the MirrorMaker2 topics.

Method Summary

Modifier and Type	Method and Description
default void	close() Closes the formatter
default void	configure(java.util.Map<java.lang.String,?> configs) Configures the MessageFormatter
default void	init(java.util.Properties props) Deprecated. Use configure(Map) instead, this method is for backward compatibility with the older Formatter interface
void	writeTo(ConsumerRecord<byte[],byte[]> consumerRecord, java.io.PrintStream output) Parses and formats a record for display

Method Detail

init

@Deprecated
default void init(java.util.Properties props)

Deprecated. Use configure(Map) instead, this method is for backward compatibility with the older Formatter interface

Initialises the MessageFormatter

Parameters:

props - Properties to configure the formatter

configure

default void configure(java.util.Map<java.lang.String,?> configs)

Configures the MessageFormatter

Specified by:

configure in interface Configurable

Parameters:

configs - Map to configure the formatter

writeTo

void writeTo(ConsumerRecord<byte[],byte[]> consumerRecord,
             java.io.PrintStream output)

Parses and formats a record for display

Parameters:

consumerRecord - the record to format

output - the print stream used to output the record

close

default void close()

Closes the formatter

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable