com.aquafold.openapi.io

Interface AQTextFileWriter

All Superinterfaces:

AQDataWriter, AQFormattedTextWriter, AQTextProcessor, java.lang.AutoCloseable, java.io.Closeable

public interface AQTextFileWriter
extends AQTextProcessor, AQFormattedTextWriter

This interface allows writing row-oriented data to text files.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEncoding() Returns output file encoding.
void	setAppendMode(boolean enable) Sets append mode.
void	setEncoding(java.lang.String encoding) Sets output file encoding.
void	setFile(java.lang.String filename) Sets output file name.
void	suppressBOM() By default, setting UTF-8 or UTF-16 encoding will cause a Byte Order Mark (BOM) written to the start of the file.

Methods inherited from interface com.aquafold.openapi.io.AQTextProcessor

setCellDelimiter, setCloseDateQuoteIdentifier, setColumnWidth, setDateFormat, setDateFormat, setDateQuoteIdentifier, setFirstLineContainsColumnNames, setNullString, setNumberFormat, setNumberFormat, setOpenDateQuoteIdentifier, setQuoteIdentifier, setQuoteIdentifier

Methods inherited from interface com.aquafold.openapi.io.AQFormattedTextWriter

getLineDelimiter, setDecimalSymbol, setDefaultDateFormat, setDefaultDateFormat, setDefaultDateTimeFormat, setDefaultDateTimeFormat, setDefaultNumberFormat, setDefaultNumberFormat, setDefaultTimeFormat, setDefaultTimeFormat, setLineDelimiter, setNullString

Methods inherited from interface com.aquafold.openapi.io.AQDataWriter

close, setColumnStructure, write, write, write, write, writeColumnNames

Method Detail

setFile

void setFile(java.lang.String filename)

Sets output file name.

Parameters:

filename - File name.

setAppendMode

void setAppendMode(boolean enable)

Sets append mode. This method must be called before any data is written out.

Parameters:

enable - (Default value: false)

setEncoding

void setEncoding(java.lang.String encoding)

Sets output file encoding. Refer to Charset for the list of supported encodings.

Parameters:

encoding - Encoding (Default value: UTF-8)

getEncoding

java.lang.String getEncoding()

Returns output file encoding.

Returns:

The encoding

suppressBOM

void suppressBOM()

By default, setting UTF-8 or UTF-16 encoding will cause a Byte Order Mark (BOM) written to the start of the file. Calling this method will prevent this from happening. This method must be called before any data is written out.