com.datastax.oss.dsbulk.format.statement

Class StatementFormatter.Builder

java.lang.Object

com.datastax.oss.dsbulk.format.statement.StatementFormatter.Builder

Enclosing class:

StatementFormatter

public static class StatementFormatter.Builder
extends Object

Helper class to build StatementFormatter instances with a fluent API.

Method Summary

Modifier and Type	Method and Description
StatementFormatter.Builder	addStatementPrinters(StatementPrinter<?>... printers) Adds the given StatementPrinters to the list of available statement printers.
StatementFormatter	build() Builds the StatementFormatter instance.
StatementFormatter.Builder	withMaxBoundValueLength(int maxBoundValueLength) Sets the maximum length, in numbers of printed characters, allowed for a single bound value.
StatementFormatter.Builder	withMaxBoundValues(int maxBoundValues) Sets the maximum number of printed bound values.
StatementFormatter.Builder	withMaxInnerStatements(int maxInnerStatements) Sets the maximum number of printed inner statements of a BatchStatement.
StatementFormatter.Builder	withMaxQueryStringLength(int maxQueryStringLength) Sets the maximum length allowed for query strings.

Methods inherited from class java.lang.Object

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

Method Detail

addStatementPrinters

public StatementFormatter.Builder addStatementPrinters(StatementPrinter<?>... printers)

Adds the given StatementPrinters to the list of available statement printers.

Note that built-in printers are always registered by default and they handle all the driver built-in Statement subclasses. Calling this method is only useful if you need to handle a special subclass of Statement; otherwise, the built-in printers should be enough.

Parameters:

printers - The StatementPrinters to add.

Returns:

this (for method chaining).

withMaxQueryStringLength

public StatementFormatter.Builder withMaxQueryStringLength(int maxQueryStringLength)

Sets the maximum length allowed for query strings. The default is .

If the query string length exceeds this threshold, printers should truncate it.

Parameters:

maxQueryStringLength - the maximum length allowed for query strings.

Returns:

this (for method chaining).

Throws:

IllegalArgumentException - if the value is not > 0, or (unlimited).

withMaxBoundValueLength

public StatementFormatter.Builder withMaxBoundValueLength(int maxBoundValueLength)

Sets the maximum length, in numbers of printed characters, allowed for a single bound value. The default is .

If the bound value length exceeds this threshold, printers should truncate it.

Parameters:

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

Returns:

this (for method chaining).

Throws:

IllegalArgumentException - if the value is not > 0, or (unlimited).

withMaxBoundValues

public StatementFormatter.Builder withMaxBoundValues(int maxBoundValues)

Sets the maximum number of printed bound values. The default is .

If the number of bound values exceeds this threshold, printers should truncate it.

Parameters:

maxBoundValues - the maximum number of printed bound values.

Returns:

this (for method chaining).

Throws:

IllegalArgumentException - if the value is not > 0, or (unlimited).

withMaxInnerStatements

public StatementFormatter.Builder withMaxInnerStatements(int maxInnerStatements)

Sets the maximum number of printed inner statements of a BatchStatement. The default is . Setting this value to zero should disable the printing of inner statements.

If the number of inner statements exceeds this threshold, printers should truncate it.

If the statement to format is not a batch statement, then this withting should be ignored.

Parameters:

maxInnerStatements - the maximum number of printed inner statements of a BatchStatement.

Returns:

this (for method chaining).

Throws:

IllegalArgumentException - if the value is not >= 0, or (unlimited).

build

public StatementFormatter build()

Builds the StatementFormatter instance.

Returns:

the StatementFormatter instance.