io.github.tuzon.java.csv.api

Class CsvWriterApi

java.lang.Object

io.github.tuzon.projects.core.base.ObjectBase

io.github.tuzon.java.csv.api.CsvApiBase

io.github.tuzon.java.csv.api.CsvWriterApi

public class CsvWriterApi
extends CsvApiBase

CSV writer API. Create CSV file. API create new CSV. In case the file already exists than the file will be overwritten. The file will be created only after execute save() method. CSV writer API can use save() only one time.

Author:

Eyal Tuzon

Field Summary

Fields inherited from class io.github.tuzon.java.csv.api.CsvApiBase

CELLS_DEFAULT_SPLITTER, cellsSplitter, csvRows, filePath, headerList

Constructor Summary

Constructors

Constructor and Description
CsvWriterApi(String filePath) Constructor.
CsvWriterApi(String filePath, CellsSplitterEnum cellsSplitter) Constructor.
CsvWriterApi(String filePath, char cellsSplitter) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addRow(List<String> row) Add a row to CSV body.
void	addRow(List<String> row, int index) Add a row to CSV body in index.
void	addRows(List<List<String>> rowList) Add a row to CSV body.
boolean	isCsvSaved() Is save() was executed.
void	removeRow(int index) Remove a row from CSV body in index place.
void	save() Save CSV to file.
void	setHeaders(List<String> headerList) Set CSV headers.

Methods inherited from class io.github.tuzon.projects.core.base.ObjectBase

validateNotNegative, validateNotNegative, validateNotNull, validateNotNull

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvWriterApi

public CsvWriterApi(String filePath)

Constructor.

Parameters:

filePath - CSV file path.

CsvWriterApi

public CsvWriterApi(String filePath,
                    CellsSplitterEnum cellsSplitter)

Constructor.

Parameters:

filePath - CSV file path.

cellsSplitter - Cells splitter enum.

CsvWriterApi

public CsvWriterApi(String filePath,
                    char cellsSplitter)

Constructor.

Parameters:

filePath - CSV file path.

cellsSplitter - Cells splitter char.

Method Detail

setHeaders

public void setHeaders(List<String> headerList)
                throws CsvOperationException,
                       io.github.tuzon.projects.core.expections.InvalidValueException

Set CSV headers. Headers can be set only one time.

Parameters:

headerList - Header list.

Throws:

CsvOperationException - in case user call the method more than one time, or run setHeaders(List) after running save() method.

io.github.tuzon.projects.core.expections.InvalidValueException - in case header list is null or headers amount is different from row size.

addRow

public void addRow(List<String> row)
            throws io.github.tuzon.projects.core.expections.InvalidValueException,
                   CsvOperationException

Add a row to CSV body.

Parameters:

row - A row of cells.

Throws:

io.github.tuzon.projects.core.expections.InvalidValueException - in case row is null or row size is different from previous headers amount or rows size.

CsvOperationException - in case run adding a row after CSV file already been saved.

addRow

public void addRow(List<String> row,
                   int index)
            throws io.github.tuzon.projects.core.expections.InvalidValueException,
                   IndexOutOfBoundsException,
                   CsvOperationException

Add a row to CSV body in index. CSV body not include headers row.

Parameters:

row - A row of cells.

index - Index of row in CSV body.

Throws:

io.github.tuzon.projects.core.expections.InvalidValueException - in case row is null, or index is negative.

IndexOutOfBoundsException - in case index is out of row bounds.

CsvOperationException - in case run adding a row after CSV file already been saved.

addRows

public void addRows(List<List<String>> rowList)
             throws io.github.tuzon.projects.core.expections.InvalidValueException,
                    CsvOperationException

Add a row to CSV body.

Parameters:

rowList - List of rows.

Throws:

io.github.tuzon.projects.core.expections.InvalidValueException - in case rowList is null.

CsvOperationException - in case run adding rows after CSV file already been saved.

removeRow

public void removeRow(int index)
               throws io.github.tuzon.projects.core.expections.InvalidValueException,
                      IndexOutOfBoundsException,
                      CsvOperationException

Remove a row from CSV body in index place. CSV body not include headers row.

Parameters:

index - Index of the row to be removed.

Throws:

io.github.tuzon.projects.core.expections.InvalidValueException - in case index is negative number.

IndexOutOfBoundsException - in case index is out of CSV rows bounds.

CsvOperationException - in case remove a row after CSV file already been saved.

save

public void save()
          throws IOException,
                 CsvOperationException

Save CSV to file. The file will be overwritten in case it is already exists. The file can be saved only one time.

Throws:

IOException - in case fail to save CSV file.

CsvOperationException - in case CSV file already been saved.

isCsvSaved

public boolean isCsvSaved()

Is save() was executed.

Returns:

true in case CSV file was saved, else return false.