com.datastax.oss.dsbulk.format.row

Class RowFormatter

java.lang.Object

com.datastax.oss.dsbulk.format.row.RowFormatter

public final class RowFormatter
extends Object

A component to format instances of Row.

Its main method is the format method.

RowFormatter provides safeguards to prevent overwhelming your logs with rows having a high number of parameters, or very long parameters.

Instances of this class are thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_VALUE_LENGTH
static int	DEFAULT_MAX_VALUES
static int	UNLIMITED A special value that conveys the notion of "unlimited".

Constructor Summary

Constructors

Constructor and Description
RowFormatter() Creates a row formatter with default settings.
RowFormatter(int maxValueLength, int maxValues) Creates a row formatter with customized settings.

Method Summary

Modifier and Type	Method and Description
String	format(Row row, ProtocolVersion protocolVersion, CodecRegistry codecRegistry) Formats the given row.
protected void	print(Row row, RowWriter out)
protected void	printHeader(Row row, RowWriter out)
protected void	printValues(Row row, RowWriter out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UNLIMITED

public static final int UNLIMITED

A special value that conveys the notion of "unlimited".

See Also:

Constant Field Values

DEFAULT_MAX_VALUE_LENGTH

public static final int DEFAULT_MAX_VALUE_LENGTH

See Also:

Constant Field Values

DEFAULT_MAX_VALUES

public static final int DEFAULT_MAX_VALUES

See Also:

Constant Field Values

Constructor Detail

RowFormatter

public RowFormatter()

Creates a row formatter with default settings.

RowFormatter

public RowFormatter(int maxValueLength,
                    int maxValues)

Creates a row formatter with customized settings.

Parameters:

maxValueLength - the maximum length, in numbers of printed characters, allowed for a single bound value.

maxValues - the maximum number of printed bound values.

Throws:

IllegalArgumentException - if maxValueLength or maxValues is not > 0, or -1 (unlimited).

Method Detail

format

public String format(Row row,
                     ProtocolVersion protocolVersion,
                     CodecRegistry codecRegistry)

Formats the given row.

Parameters:

row - The row to format; must not be null.

protocolVersion - The protocol version in use.

codecRegistry - The codec registry in use.

Returns:

The row as a formatted string.

print

protected void print(Row row,
                     RowWriter out)

printHeader

protected void printHeader(Row row,
                           RowWriter out)

printValues

protected void printValues(Row row,
                           RowWriter out)