StatementWriter (DataStax Bulk Loader 1.8.0 API)

java.lang.Object
- com.datastax.oss.dsbulk.format.statement.StatementWriter

All Implemented Interfaces:

Appendable
```
public final class StatementWriter
extends Object
implements Appendable
```
This class exposes utility methods to help statement printers in formatting a statement.
Instances of this class are designed to format one single statement; they keep internal counters such as the current number of printed bound values, and for this reason, they should not be reused to format more than one statement. When formatting more than one statement (e.g. when formatting a BatchStatement and its children), one should call createChildWriter() to create child instances of the main writer to format each individual statement.
This class is NOT thread-safe.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StatementWriter`	`append(char c)`
`StatementWriter`	`append(CharSequence csq)`
`StatementWriter`	`append(CharSequence csq, int start, int end)`
`StatementWriter`	`append(Object obj)`
`StatementWriter`	`append(String str)`
`void`	`appendBoundValue(int index, Object value, DataType type)`
`void`	`appendBoundValue(String name, Object value, DataType type)`
`StatementWriter`	`appendClassNameAndHashCode(Statement<?> statement)` Appends the statement's class name and hash code, as done by `Object.toString()`.
`void`	`appendQueryStringFragment(String queryStringFragment)` Appends the given fragment as a query string fragment.
`void`	`appendUnsetBoundValue(String name)`
`StatementWriter`	`createChildWriter()` Creates and returns a child `StatementWriter`.
`CodecRegistry`	`getCodecRegistry()`
`StatementFormatterLimits`	`getLimits()`
`StatementPrinterRegistry`	`getPrinterRegistry()`
`ProtocolVersion`	`getProtocolVersion()`
`StatementWriter`	`indent()`
`boolean`	`maxAppendedBoundValuesExceeded()`
`boolean`	`maxQueryStringLengthExceeded()`
`StatementWriter`	`newLine()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - createChildWriter
```
public StatementWriter createChildWriter()
```
    Creates and returns a child StatementWriter.
    A child writer shares the same buffer as its parent, but has its own independent state. It is most useful when dealing with inner statements in batches (each inner statement should use a child writer).
    
    Returns:
    
    a child StatementWriter.
  - getPrinterRegistry
```
public StatementPrinterRegistry getPrinterRegistry()
```
    Returns:
    
    The printer registry.
  - getLimits
```
public StatementFormatterLimits getLimits()
```
    Returns:
    
    The current limits.
  - getProtocolVersion
```
public ProtocolVersion getProtocolVersion()
```
    Returns:
    
    The protocol version in use.
  - getCodecRegistry
```
public CodecRegistry getCodecRegistry()
```
    Returns:
    
    The codec registry version in use.
  - maxQueryStringLengthExceeded
```
public boolean maxQueryStringLengthExceeded()
```
    Returns:
    
    true if the maximum query string length is exceeded, false otherwise.
  - maxAppendedBoundValuesExceeded
```
public boolean maxAppendedBoundValuesExceeded()
```
    Returns:
    
    true if the maximum number of bound values per statement is exceeded, false otherwise.
  - newLine
```
public StatementWriter newLine()
```
  - indent
```
public StatementWriter indent()
```
  - append
```
public StatementWriter append(CharSequence csq)
```
    Specified by:
    
    append in interface Appendable
  - append
```
public StatementWriter append(CharSequence csq,
                              int start,
                              int end)
```
    Specified by:
    
    append in interface Appendable
  - append
```
public StatementWriter append(char c)
```
    Specified by:
    
    append in interface Appendable
  - append
```
public StatementWriter append(Object obj)
```
  - append
```
public StatementWriter append(String str)
```
  - appendClassNameAndHashCode
```
public StatementWriter appendClassNameAndHashCode(Statement<?> statement)
```
    Appends the statement's class name and hash code, as done by Object.toString().
    
    Parameters:
    
    statement - The statement to format.
    
    Returns:
    
    this (for method chaining).
  - appendQueryStringFragment
```
public void appendQueryStringFragment(String queryStringFragment)
```
    Appends the given fragment as a query string fragment.
    This method can be called multiple times, in case the printer needs to compute the query string by pieces.
    This methods also keeps track of the amount of characters used so far to print the query string, and automatically detects when the query string exceeds the maximum length, in which case it truncates the output.
    
    Parameters:
    
    queryStringFragment - The query string fragment to append
  - appendBoundValue
```
public void appendBoundValue(int index,
                             Object value,
                             DataType type)
```
  - appendBoundValue
```
public void appendBoundValue(String name,
                             Object value,
                             DataType type)
```
  - appendUnsetBoundValue
```
public void appendUnsetBoundValue(String name)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class StatementWriter

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createChildWriter

getPrinterRegistry

getLimits

getProtocolVersion

getCodecRegistry

maxQueryStringLengthExceeded

maxAppendedBoundValuesExceeded

newLine

indent

append

append

append

append

append

appendClassNameAndHashCode

appendQueryStringFragment

appendBoundValue

appendBoundValue

appendUnsetBoundValue

toString