Package io.github.mbenincasa.javaexcelutils.tools

Class Converter

java.lang.Object

io.github.mbenincasa.javaexcelutils.tools.Converter

public class Converter
extends Object

Converter is the static class with implementations of conversion methods

Since:

0.2.0

Author:

Mirko Benincasa

Constructor Summary

Constructors

Constructor	Description
Converter()

Method Summary

Modifier and Type	Method	Description
static byte[]	csvToExcelByte(byte[] bytes, String sheetName, Extension extension)
static File	csvToExcelFile(File fileInput, String sheetName, String pathname, Extension extension)
static ByteArrayOutputStream	csvToExcelStream(InputStream inputStream, String sheetName, Extension extension)
static Map<String,java.util.stream.Stream<?>>	excelByteToObjects(byte[] bytes, List<ExcelToObject<?>> excelToObjects)
static Map<String,java.util.stream.Stream<?>>	excelFileToObjects(File file, List<ExcelToObject<?>> excelToObjects)
static Map<String,java.util.stream.Stream<?>>	excelStreamToObjects(InputStream inputStream, List<ExcelToObject<?>> excelToObjects)
static Map<String,byte[]>	excelToCsvByte(byte[] bytes)
static Map<String,File>	excelToCsvFile(File excelFile, String path)
static Map<String,ByteArrayOutputStream>	excelToCsvStream(InputStream excelInputStream)
static byte[]	excelToJsonByte(byte[] bytes)
static File	excelToJsonFile(File excelFile, String pathname)
static ByteArrayOutputStream	excelToJsonStream(InputStream excelInputStream)
static <T> byte[]	jsonToExcelByte(byte[] bytes, JsonToExcel<T> jsonToExcel, Extension extension, Boolean writeHeader)
static <T> File	jsonToExcelFile(File jsonFile, JsonToExcel<T> jsonToExcel, Extension extension, String filename, Boolean writeHeader)
static <T> ByteArrayOutputStream	jsonToExcelStream(InputStream jsonStream, JsonToExcel<T> jsonToExcel, Extension extension, Boolean writeHeader)
static byte[]	objectsToExcelByte(List<ObjectToExcel<?>> objectToExcels, Extension extension, Boolean writeHeader)
static File	objectsToExcelFile(List<ObjectToExcel<?>> objectToExcels, Extension extension, String filename, Boolean writeHeader)
static ByteArrayOutputStream	objectsToExcelStream(List<ObjectToExcel<?>> objectToExcels, Extension extension, Boolean writeHeader)

Methods inherited from class java.lang.Object

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

Constructor Details

Converter

public Converter()

Method Details

objectsToExcelFile

public static File objectsToExcelFile(List<ObjectToExcel<?>> objectToExcels,
 Extension extension,
 String filename,
 Boolean writeHeader)
                               throws ExtensionNotValidException,
IOException,
FileAlreadyExistsException,
SheetAlreadyExistsException

Parameters:

objectToExcels - A list of ObjectToExcels. Each element represents a Sheet

extension - The extension to assign to the Excel file

filename - The name, including the path, to be associated with the File.

Note: Do not add the extension

writeHeader - If true it will write the header to the first line

Returns:

The Excel file generated by the conversion

Throws:

ExtensionNotValidException - If the input file extension does not belong to an Excel file

IOException - If an I/O error has occurred

FileAlreadyExistsException - If the destination file already exists

SheetAlreadyExistsException - If you try to insert a Sheet that already exists

Since:

0.4.0

objectsToExcelByte

public static byte[] objectsToExcelByte(List<ObjectToExcel<?>> objectToExcels,
 Extension extension,
 Boolean writeHeader)
                                 throws ExtensionNotValidException,
IOException,
SheetAlreadyExistsException

Parameters:

objectToExcels - A list of ObjectToExcels. Each element represents a Sheet

extension - The extension to assign to the Excel file

writeHeader - If true it will write the header to the first line

Returns:

The Excel OutputStream generated by the conversion in the form of a byte array

Throws:

ExtensionNotValidException - If the input file extension does not belong to an Excel file

IOException - If an I/O error has occurred

SheetAlreadyExistsException - If you try to insert a Sheet that already exists

Since:

0.4.0

objectsToExcelStream

public static ByteArrayOutputStream objectsToExcelStream(List<ObjectToExcel<?>> objectToExcels,
 Extension extension,
 Boolean writeHeader)
                                                  throws ExtensionNotValidException,
IOException,
SheetAlreadyExistsException

Parameters:

objectToExcels - A list of ObjectToExcels. Each element represents a Sheet

extension - The extension to assign to the Excel file

writeHeader - If true it will write the header to the first line

Returns:

The Excel OutputStream generated by the conversion in the form of a ByteArrayOutputStream

Throws:

ExtensionNotValidException - If the input file extension does not belong to an Excel file

IOException - If an I/O error has occurred

SheetAlreadyExistsException - If you try to insert a Sheet that already exists

Since:

0.4.0

excelByteToObjects

public static Map<String,java.util.stream.Stream<?>> excelByteToObjects(byte[] bytes,
 List<ExcelToObject<?>> excelToObjects)
                                                                 throws OpenWorkbookException,
SheetNotFoundException,
ReadValueException,
HeaderNotPresentException,
InvocationTargetException,
NoSuchMethodException,
InstantiationException,
IllegalAccessException,
IOException

Parameters:

bytes - The byte array of the Excel file

excelToObjects - A list of ExcelToObject. Each element represents a Sheet

Returns:

A map where the key represents the name of the Sheet and the value the Stream of objects present in the sheet

Throws:

OpenWorkbookException - If an error occurred while opening the workbook

SheetNotFoundException - If the sheet to open is not found

ReadValueException - If an error occurs while reading a cell

HeaderNotPresentException - If the first row is empty and does not contain the header

InvocationTargetException - If an error occurs while instantiating a new object or setting a field

NoSuchMethodException - If the setting method or empty constructor of the object is not found

InstantiationException - f an error occurs while instantiating a new object

IllegalAccessException - If a field or fields of the clazz could not be accessed

IOException - If an I/O error occurs

Since:

0.4.0

excelFileToObjects

public static Map<String,java.util.stream.Stream<?>> excelFileToObjects(File file,
 List<ExcelToObject<?>> excelToObjects)
                                                                 throws IOException,
OpenWorkbookException,
SheetNotFoundException,
ReadValueException,
HeaderNotPresentException,
InvocationTargetException,
NoSuchMethodException,
InstantiationException,
IllegalAccessException,
ExtensionNotValidException

Parameters:

file - The Excel file

excelToObjects - A list of ExcelToObject. Each element represents a Sheet

Returns:

A map where the key represents the name of the Sheet and the value the Stream of objects present in the sheet

Throws:

IOException - If an I/O error occurs

OpenWorkbookException - If an error occurred while opening the workbook

SheetNotFoundException - If the sheet to open is not found

ReadValueException - If an error occurs while reading a cell

HeaderNotPresentException - If the first row is empty and does not contain the header

InvocationTargetException - If an error occurs while instantiating a new object or setting a field

NoSuchMethodException - If the setting method or empty constructor of the object is not found

InstantiationException - If an error occurs while instantiating a new object

IllegalAccessException - If a field or fields of the clazz could not be accessed

ExtensionNotValidException - If the input file extension does not belong to an Excel file

Since:

0.4.0

excelStreamToObjects

public static Map<String,java.util.stream.Stream<?>> excelStreamToObjects(InputStream inputStream,
 List<ExcelToObject<?>> excelToObjects)
                                                                   throws OpenWorkbookException,
SheetNotFoundException,
HeaderNotPresentException,
NoSuchMethodException,
InvocationTargetException,
InstantiationException,
IllegalAccessException,
ReadValueException,
IOException

Parameters:

inputStream - The InputStream of the Excel file

excelToObjects - A list of ExcelToObject. Each element represents a Sheet

Returns:

A map where the key represents the name of the Sheet and the value the Stream of objects present in the sheet

Throws:

OpenWorkbookException - If an error occurred while opening the workbook

SheetNotFoundException - If the sheet to open is not found

HeaderNotPresentException - If the first row is empty and does not contain the header

NoSuchMethodException - If the setting method or empty constructor of the object is not found

InvocationTargetException - If an error occurs while instantiating a new object or setting a field

InstantiationException - f an error occurs while instantiating a new object

IllegalAccessException - If a field or fields of the clazz could not be accessed

ReadValueException - If an error occurs while reading a cell

IOException - If an I/O error occurs

Since:

0.4.0

excelToCsvByte

public static Map<String,byte[]> excelToCsvByte(byte[] bytes)
                                         throws OpenWorkbookException,
IOException

Parameters:

bytes - The Excel file in the form of a byte array

Returns:

A map where the key represents the Sheet name and the value is a CSV file for each Sheet

Throws:

OpenWorkbookException - If an error occurred while opening the workbook

IOException - If an I/O error has occurred

Since:

0.4.0

excelToCsvFile

public static Map<String,File> excelToCsvFile(File excelFile,
 String path)
                                       throws IOException,
OpenWorkbookException,
ExtensionNotValidException

Parameters:

excelFile - The Excel file

path - The path, without file name, where the files will be saved

Returns:

A map where the key represents the Sheet name and the value is a CSV file for each Sheet

Throws:

IOException - If an I/O error has occurred

OpenWorkbookException - If an error occurred while opening the workbook

ExtensionNotValidException - If an extension is not correct

Since:

0.4.0

excelToCsvStream

public static Map<String,ByteArrayOutputStream> excelToCsvStream(InputStream excelInputStream)
                                                          throws OpenWorkbookException,
IOException

Parameters:

excelInputStream - The Excel file in the form of an InputStream

Returns:

A map where the key represents the Sheet name and the value is a CSV file for each Sheet

Throws:

OpenWorkbookException - If an error occurred while opening the workbook

IOException - If an I/O error has occurred

Since:

0.4.0

csvToExcelByte

public static byte[] csvToExcelByte(byte[] bytes,
 String sheetName,
 Extension extension)
                             throws com.opencsv.exceptions.CsvValidationException,
ExtensionNotValidException,
IOException,
SheetAlreadyExistsException

Parameters:

bytes - The CSV file in the form of a byte array

sheetName - The name of the sheet to create

extension - The extension of the output file. Select an extension with type EXCEL

Returns:

The Excel file in the form of a byte array

Throws:

com.opencsv.exceptions.CsvValidationException - If the CSV file has invalid formatting

ExtensionNotValidException - If an extension is not correct

IOException - If an I/O error has occurred

SheetAlreadyExistsException - If you try to insert a Sheet that already exists

Since:

0.4.0

csvToExcelFile

public static File csvToExcelFile(File fileInput,
 String sheetName,
 String pathname,
 Extension extension)
                           throws IOException,
com.opencsv.exceptions.CsvValidationException,
ExtensionNotValidException,
SheetAlreadyExistsException

Parameters:

fileInput - The CSV file

sheetName - The name of the sheet to create

pathname - The path with the file name. Note: Do not add the extension

extension - The extension of the output file. Select an extension with type EXCEL

Returns:

The Excel file

Throws:

IOException - If an I/O error has occurred

com.opencsv.exceptions.CsvValidationException - If the CSV file has invalid formatting

ExtensionNotValidException - If an extension is not correct

SheetAlreadyExistsException - If you try to insert a Sheet that already exists

Since:

0.4.0

csvToExcelStream

public static ByteArrayOutputStream csvToExcelStream(InputStream inputStream,
 String sheetName,
 Extension extension)
                                              throws ExtensionNotValidException,
com.opencsv.exceptions.CsvValidationException,
IOException,
SheetAlreadyExistsException

Parameters:

inputStream - The CSV file in the form of a InputStream

sheetName - The name of the sheet to create

extension - The extension of the output file. Select an extension with type EXCEL

Returns:

The Excel file in the form of a ByteArrayOutputStream

Throws:

ExtensionNotValidException - If an extension is not correct

com.opencsv.exceptions.CsvValidationException - If the CSV file has invalid formatting

IOException - If an I/O error has occurred

SheetAlreadyExistsException - If you try to insert a Sheet that already exists

Since:

0.4.0

excelToJsonByte

public static byte[] excelToJsonByte(byte[] bytes)
                              throws OpenWorkbookException,
IOException

Parameters:

bytes - The Excel file in the form of a byte array

Returns:

The Json file in the form of a byte array

Throws:

OpenWorkbookException - If an error occurred while opening the workbook

IOException - If an I/O error has occurred

Since:

0.4.0

excelToJsonFile

public static File excelToJsonFile(File excelFile,
 String pathname)
                            throws IOException,
OpenWorkbookException,
ExtensionNotValidException

Parameters:

excelFile - The Excel file

pathname - The path with the file name. Note: Do not add the extension

Returns:

The Json file

Throws:

IOException - If an I/O error has occurred

OpenWorkbookException - If an error occurred while opening the workbook

ExtensionNotValidException - If the extension is incorrect

Since:

0.4.0

excelToJsonStream

public static ByteArrayOutputStream excelToJsonStream(InputStream excelInputStream)
                                               throws OpenWorkbookException,
IOException

Parameters:

excelInputStream - The Excel file in the form of an InputStream

Returns:

The Json file in the form of a ByteArrayOutputStream

Throws:

OpenWorkbookException - If an error occurred while opening the workbook

IOException - If an I/O error has occurred

Since:

0.4.0

jsonToExcelByte

public static <T> byte[] jsonToExcelByte(byte[] bytes,
 JsonToExcel<T> jsonToExcel,
 Extension extension,
 Boolean writeHeader)
                                  throws ExtensionNotValidException,
IOException,
SheetAlreadyExistsException

Type Parameters:

T - The class parameter of the object

Parameters:

bytes - The Json file in the form of a byte array. Note: Must be formatted as an array of objects

jsonToExcel - It is used to convert Json elements into objects

extension - The extension of the output file. Select an extension with type EXCEL

writeHeader - If true it will write the header to the first line

Returns:

The Excel file in the form of a byte array

Throws:

ExtensionNotValidException - If the extension is incorrect

IOException - If an I/O error has occurred

SheetAlreadyExistsException - If you try to insert a Sheet that already exists

Since:

0.4.0

jsonToExcelFile

public static <T> File jsonToExcelFile(File jsonFile,
 JsonToExcel<T> jsonToExcel,
 Extension extension,
 String filename,
 Boolean writeHeader)
                                throws IOException,
ExtensionNotValidException,
FileAlreadyExistsException,
SheetAlreadyExistsException

Type Parameters:

T - The class parameter of the object

Parameters:

jsonFile - The Json file. Note: Must be formatted as an array of objects

jsonToExcel - It is used to convert Json elements into objects

extension - The extension of the output file. Select an extension with type EXCEL

filename - File name, including path, to specify where to save. Note: Do not add the extension

writeHeader - If true it will write the header to the first line

Returns:

The Excel file

Throws:

IOException - If an I/O error has occurred

ExtensionNotValidException - If the extension is incorrect

FileAlreadyExistsException - If the destination file already exists

SheetAlreadyExistsException - If you try to insert a Sheet that already exists

Since:

0.4.0

jsonToExcelStream

public static <T> ByteArrayOutputStream jsonToExcelStream(InputStream jsonStream,
 JsonToExcel<T> jsonToExcel,
 Extension extension,
 Boolean writeHeader)
                                                   throws ExtensionNotValidException,
IOException,
SheetAlreadyExistsException

Type Parameters:

T - The class parameter of the object

Parameters:

jsonStream - The Json file in the form of an InputStream. Note: Must be formatted as an array of objects

jsonToExcel - It is used to convert Json elements into objects

extension - The extension of the output file. Select an extension with type EXCEL

writeHeader - If true it will write the header to the first line

Returns:

The Excel file in the form of a ByteArrayOutputStream

Throws:

ExtensionNotValidException - If the extension is incorrect

IOException - If an I/O error has occurred

SheetAlreadyExistsException - If you try to insert a Sheet that already exists

Since:

0.4.0