Package 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetEncoding()Returns output file encoding.voidsetAppendMode(boolean enable)Sets append mode.voidsetEncoding(java.lang.String encoding)Sets output file encoding.voidsetFile(java.lang.String filename)Sets output file name.voidsuppressBOM()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.AQDataWriter
close, setColumnStructure, write, write, write, write, writeColumnNames
-
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.AQTextProcessor
setCellDelimiter, setCloseDateQuoteIdentifier, setColumnWidth, setDateFormat, setDateFormat, setDateQuoteIdentifier, setFirstLineContainsColumnNames, setNullString, setNumberFormat, setNumberFormat, setOpenDateQuoteIdentifier, setQuoteIdentifier, setQuoteIdentifier
-
-
-
-
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 toCharsetfor 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.
-
-