Class InventoryCsvWriter

java.lang.Object

com.amilesend.discogs.csv.InventoryCsvWriter

All Implemented Interfaces:

AutoCloseable

public class InventoryCsvWriter
extends Object
implements AutoCloseable

Utility to write an inventory CSV file used for Discogs inventory management (i.e., creating new inventory items, or update existing inventory items).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InventoryCsvWriter.InventoryCsvWriterBuilder

Method Summary

Modifier and Type	Method	Description
static InventoryCsvWriter.InventoryCsvWriterBuilder	builder()
void	close()
boolean	equals(Object o)
Path	getCsvFile()	The path of the CSV file to write.
org.apache.commons.csv.CSVPrinter	getCsvPrinter()	The printer used to format and write to the file.
List<InventoryHeader>	getHeaders()	The list of defined CSV headers to be included in the CSV file.
InventoryRecordType	getRecordType()	The record type (i.e., for new inventory items, or to update existing items).
int	hashCode()
boolean	isAppended()	Indicator to append an existing file, or to overwrite and create a new CSV file.
String	toString()
void	write(@NonNull InventoryRecord record)	Writes a record to the CSV file.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

write

public void write(@NonNull InventoryRecord record)
           throws ValidationException,
IOException

Writes a record to the CSV file.

Parameters:

record - the record to write

Throws:

ValidationException - if there is an error with the record

IOException - if there is an issue writing the record to the file

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

builder

public static InventoryCsvWriter.InventoryCsvWriterBuilder builder()

getCsvFile

public Path getCsvFile()

The path of the CSV file to write.

isAppended

public boolean isAppended()

Indicator to append an existing file, or to overwrite and create a new CSV file.

getHeaders

public List<InventoryHeader> getHeaders()

The list of defined CSV headers to be included in the CSV file.

See Also:

• InventoryHeader

getCsvPrinter

public org.apache.commons.csv.CSVPrinter getCsvPrinter()

The printer used to format and write to the file.

getRecordType

public InventoryRecordType getRecordType()

The record type (i.e., for new inventory items, or to update existing items).

See Also:

• InventoryRecordType

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object