Package org.refcodes.tabular

Class CsvStringRecordsWriter

java.lang.Object

org.refcodes.tabular.CsvRecordsWriter<java.lang.String>

org.refcodes.tabular.CsvStringRecordsWriter

All Implemented Interfaces:

java.lang.AutoCloseable, HeaderAccessor<java.lang.String>, RecordsWriter<java.lang.String>

public class CsvStringRecordsWriter
extends CsvRecordsWriter<java.lang.String>

Author:

steiner

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.textual.CsvEscapeModeAccessor

org.refcodes.textual.CsvEscapeModeAccessor.CsvEscapeModeBuilder<B extends org.refcodes.textual.CsvEscapeModeAccessor.CsvEscapeModeBuilder<?>>, org.refcodes.textual.CsvEscapeModeAccessor.CsvEscapeModeMutator, org.refcodes.textual.CsvEscapeModeAccessor.CsvEscapeModeProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.DelimiterAccessor

org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B extends org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B>>, org.refcodes.mixin.DelimiterAccessor.DelimiterMutator, org.refcodes.mixin.DelimiterAccessor.DelimiterProperty

Nested classes/interfaces inherited from interface org.refcodes.tabular.HeaderAccessor

HeaderAccessor.HeaderBuilder<T extends HeaderAccessor.HeaderBuilder<?>>, HeaderAccessor.HeaderMutator<T>, HeaderAccessor.HeaderProperty<T>

Nested classes/interfaces inherited from interface org.refcodes.mixin.TrimAccessor

org.refcodes.mixin.TrimAccessor.TrimBuilder<B extends org.refcodes.mixin.TrimAccessor.TrimBuilder<B>>, org.refcodes.mixin.TrimAccessor.TrimMutator, org.refcodes.mixin.TrimAccessor.TrimProperty

Field Summary

Fields inherited from class org.refcodes.tabular.CsvRecordsWriter

_csvBuilder, _header, _outputStream

Constructor Summary

Constructors

Constructor	Description
CsvStringRecordsWriter(java.io.File aFile)
CsvStringRecordsWriter(java.io.File aFile, char aCsvDelimiter)
CsvStringRecordsWriter(java.io.OutputStream aOutputStream)
CsvStringRecordsWriter(java.io.PrintStream aPrintStream)
CsvStringRecordsWriter(ColumnFactory<java.lang.String> aColumnFactory, java.io.File aFile)
CsvStringRecordsWriter(ColumnFactory<java.lang.String> aColumnFactory, java.io.File aFile, char aCsvDelimiter)
CsvStringRecordsWriter(ColumnFactory<java.lang.String> aColumnFactory, java.io.OutputStream aOutputStream)
CsvStringRecordsWriter(ColumnFactory<java.lang.String> aColumnFactory, java.io.OutputStream aOutputStream, char aCsvDelimiter)
CsvStringRecordsWriter(ColumnFactory<java.lang.String> aColumnFactory, java.io.PrintStream aPrintStream)
CsvStringRecordsWriter(ColumnFactory<java.lang.String> aColumnFactory, java.io.PrintStream aOutputStream, char aCsvDelimiter)
CsvStringRecordsWriter(Header<java.lang.String> aHeader, java.io.File aFile)
CsvStringRecordsWriter(Header<java.lang.String> aHeader, java.io.File aFile, char aCsvDelimiter)
CsvStringRecordsWriter(Header<java.lang.String> aHeader, java.io.OutputStream aOutputStream)
CsvStringRecordsWriter(Header<java.lang.String> aHeader, java.io.OutputStream aOutputStream, char aCsvDelimiter)
CsvStringRecordsWriter(Header<java.lang.String> aHeader, java.io.PrintStream aPrintStream)
CsvStringRecordsWriter(Header<java.lang.String> aHeader, java.io.PrintStream aPrintStream, char aCsvDelimiter)

Method Summary

Modifier and Type	Method	Description
CsvStringRecordsWriter	withCommentPrefixes(java.lang.String... aCommentPrefixes)
CsvStringRecordsWriter	withCsvEscapeMode(org.refcodes.textual.CsvEscapeMode aCsvEscapeMode)
CsvStringRecordsWriter	withDelimiter(char aCsvDelimiter)
CsvStringRecordsWriter	withTrim(boolean isTrimRecords)
void	writeNext(java.lang.String... aRecord)	Provides the String variant of the CsvRecordsWriter.writeNext(Object...) method.

Methods inherited from interface org.refcodes.textual.CsvMixin

isComment, toComment, uncomment

Methods inherited from class org.refcodes.tabular.CsvRecordsWriter

clearCommentPrefixes, close, getCommentPrefixes, getCsvEscapeMode, getDelimiter, getHeader, isTrim, parseHeader, setCommentPrefixes, setCsvEscapeMode, setDelimiter, setTrim, writeComment, writeHeader, writeHeader, writeHeader, writeHeaderComment, writeHeaderComment, writeHeaderComment, writeNext, writeNext

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvStringRecordsWriter

public CsvStringRecordsWriter(ColumnFactory<java.lang.String> aColumnFactory,
                              java.io.File aFile,
                              char aCsvDelimiter)
                       throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

CsvStringRecordsWriter

public CsvStringRecordsWriter(ColumnFactory<java.lang.String> aColumnFactory,
                              java.io.File aFile)
                       throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

CsvStringRecordsWriter

public CsvStringRecordsWriter(ColumnFactory<java.lang.String> aColumnFactory,
                              java.io.OutputStream aOutputStream,
                              char aCsvDelimiter)

CsvStringRecordsWriter

public CsvStringRecordsWriter(ColumnFactory<java.lang.String> aColumnFactory,
                              java.io.OutputStream aOutputStream)

CsvStringRecordsWriter

public CsvStringRecordsWriter(ColumnFactory<java.lang.String> aColumnFactory,
                              java.io.PrintStream aOutputStream,
                              char aCsvDelimiter)

CsvStringRecordsWriter

public CsvStringRecordsWriter(ColumnFactory<java.lang.String> aColumnFactory,
                              java.io.PrintStream aPrintStream)

CsvStringRecordsWriter

public CsvStringRecordsWriter(java.io.File aFile)
                       throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

CsvStringRecordsWriter

public CsvStringRecordsWriter(java.io.File aFile,
                              char aCsvDelimiter)
                       throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

CsvStringRecordsWriter

public CsvStringRecordsWriter(Header<java.lang.String> aHeader,
                              java.io.File aFile,
                              char aCsvDelimiter)
                       throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

CsvStringRecordsWriter

public CsvStringRecordsWriter(Header<java.lang.String> aHeader,
                              java.io.File aFile)
                       throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

CsvStringRecordsWriter

public CsvStringRecordsWriter(Header<java.lang.String> aHeader,
                              java.io.OutputStream aOutputStream,
                              char aCsvDelimiter)

CsvStringRecordsWriter

public CsvStringRecordsWriter(Header<java.lang.String> aHeader,
                              java.io.OutputStream aOutputStream)

CsvStringRecordsWriter

public CsvStringRecordsWriter(Header<java.lang.String> aHeader,
                              java.io.PrintStream aPrintStream,
                              char aCsvDelimiter)

CsvStringRecordsWriter

public CsvStringRecordsWriter(Header<java.lang.String> aHeader,
                              java.io.PrintStream aPrintStream)

CsvStringRecordsWriter

public CsvStringRecordsWriter(java.io.OutputStream aOutputStream)

CsvStringRecordsWriter

public CsvStringRecordsWriter(java.io.PrintStream aPrintStream)

Method Detail

withTrim

public CsvStringRecordsWriter withTrim(boolean isTrimRecords)

Overrides:

withTrim in class CsvRecordsWriter<java.lang.String>

withCsvEscapeMode

public CsvStringRecordsWriter withCsvEscapeMode(org.refcodes.textual.CsvEscapeMode aCsvEscapeMode)

Overrides:

withCsvEscapeMode in class CsvRecordsWriter<java.lang.String>

withDelimiter

public CsvStringRecordsWriter withDelimiter(char aCsvDelimiter)

Overrides:

withDelimiter in class CsvRecordsWriter<java.lang.String>

withCommentPrefixes

public CsvStringRecordsWriter withCommentPrefixes(java.lang.String... aCommentPrefixes)

Overrides:

withCommentPrefixes in class CsvRecordsWriter<java.lang.String>

writeNext

public void writeNext(java.lang.String... aRecord)
               throws java.lang.IllegalArgumentException

Provides the String variant of the CsvRecordsWriter.writeNext(Object...) method.

Parameters:

aRecord - The String instances to be logged.

Throws:

java.lang.IllegalArgumentException - thrown in case the provided String instances do not align with the header (as of CsvRecordsWriter.getHeader()).