Module org.refcodes.tabular

Package org.refcodes.tabular

Interface RecordWriter<T>

Type Parameters:

T - The type of the Record instances being used.

All Superinterfaces:

AutoCloseable, HeaderAccessor<T>, org.refcodes.io.RowWriter<T[]>

All Known Implementing Classes:

CsvRecordWriter, CsvStringRecordWriter

public interface RecordWriter<T>
extends org.refcodes.io.RowWriter<T[]>, HeaderAccessor<T>

The RecordWriter writes data.

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method	Description
void	parseHeader(String... aHeader)	Parses and sets the Header from the provided String.
void	writeHeader()	Writes the CSV header to the writer (be it a Stream or a File).
void	writeHeader(String... aHeader)	Parses and sets the Header from the provided String arguments and writes the CSV header to the writer (be it a Stream or a File).
void	writeHeader(Header<T> aHeader)	Sets and writes the provided Header to the writer (be it a Stream or a File). .
void	writeNext(Record<T> aRecord)	Directly logs the provided String instances to the writer.
void	writeNext(T... aRecord)	Directly logs the provided instances to the writer.
default <TYPE> void	writeNextLine(String... aRecord)	Directly writes the provided instance to the writer.
default <TYPE> void	writeNextType(TYPE aRecord)	Directly logs the provided instance to the writer.

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface org.refcodes.tabular.HeaderAccessor

getHeader

Method Detail

parseHeader

void parseHeader(String... aHeader)

Parses and sets the Header from the provided String. You must have provided a ColumnFactory for this operation to succeed.

Parameters:

aHeader - The header to be created.

writeHeader

void writeHeader(String... aHeader)

Parses and sets the Header from the provided String arguments and writes the CSV header to the writer (be it a Stream or a File). You must have provided a ColumnFactory for this operation to succeed.

Parameters:

aHeader - The header to be created.

writeHeader

void writeHeader(Header<T> aHeader)

Sets and writes the provided Header to the writer (be it a Stream or a File). .

Parameters:

aHeader - The header to be created.

writeHeader

void writeHeader()

Writes the CSV header to the writer (be it a Stream or a File). You must have provided a Header for this operation to succeed.

writeNext

void writeNext(T... aRecord)
        throws IllegalArgumentException

Directly logs the provided instances to the writer.

Specified by:

writeNext in interface org.refcodes.io.RowWriter<T>

Parameters:

aRecord - The instances to be logged.

Throws:

IllegalArgumentException - thrown in case the provided objects do not align with the header (as of HeaderAccessor.getHeader()).

writeNextType

default <TYPE> void writeNextType(TYPE aRecord)
                           throws IllegalArgumentException

Directly logs the provided instance to the writer. The properties of the given type matching the header are written accordingly.

Type Parameters:

TYPE - the generic type

Parameters:

aRecord - The instance to be logged.

Throws:

IllegalArgumentException - thrown in case the provided objects do not align with the header (as of HeaderAccessor.getHeader()).

writeNextLine

default <TYPE> void writeNextLine(String... aRecord)
                           throws IllegalArgumentException,
                                  ColumnMismatchException,
                                  HeaderMismatchException,
                                  ParseException

Directly writes the provided instance to the writer. The properties of the given type in the given order matching the header are written accordingly.

Type Parameters:

TYPE - the generic type

Parameters:

aRecord - The instance to be logged.

Throws:

IllegalArgumentException - thrown in case the provided objects do not align with the header (as of HeaderAccessor.getHeader()).

ColumnMismatchException - thrown in case a value was found in the e.g. in a Record of the wrong type than specified by a provided Column (of for example a Header).

HeaderMismatchException - Thrown in case there is a mismatch between the given Header and a Row (or another Header), i.e. the index for the given key in a header may be out of index of a given row or the given key does not exist in a Header.

ParseException - in case parsing the input was not possible.

writeNext

void writeNext(Record<T> aRecord)
        throws ColumnMismatchException,
               HeaderMismatchException

Directly logs the provided String instances to the writer.

Parameters:

aRecord - The String instances to be logged.

Throws:

ColumnMismatchException - Thrown in case a value was found in the e.g. in a Record of the wrong type than specified by a provided Column (of for example a Header).

HeaderMismatchException - Thrown in case there is a mismatch between the given HeaderMismatchException and the Row, i.e. the index for the given key in the header may be out of index of the given row or the given key does not exist in the Header.