org.supercsv.io.ICsvBeanReader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of super-csv Show documentation
Show all versions of super-csv Show documentation
Super CSV is a fast, programmer-friendly, free CSV package for Java
/*
* Copyright 2007 Kasper B. Graversen
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.supercsv.io;
import java.io.IOException;
import org.supercsv.cellprocessor.ift.CellProcessor;
import org.supercsv.exception.SuperCsvConstraintViolationException;
import org.supercsv.exception.SuperCsvException;
import org.supercsv.exception.SuperCsvReflectionException;
/**
* Interface for CSV readers reading into objects/beans.
*
* @author Kasper B. Graversen
* @author James Bassett
*/
public interface ICsvBeanReader extends ICsvReader {
/**
* Reads a row of a CSV file and populates an instance of the specified class, using the supplied name mapping to
* map column values to the appropriate fields.
*
* @param clazz
* the type to instantiate. If the type is a class then a new instance will be created using the default
* no-args constructor. If the type is an interface, a proxy object which implements the interface will
* be created instead.
* @param nameMapping
* an array of Strings linking the CSV columns to their corresponding field in the bean (the array length
* should match the number of columns). A null entry in the array indicates that the column
* should be ignored (the field in the bean will be null - or its default value).
* @param
* the bean type
* @return a populated bean or null if EOF
* @throws IOException
* if an I/O error occurred
* @throws IllegalArgumentException
* if nameMapping.length != number of columns read
* @throws NullPointerException
* if clazz or nameMapping are null
* @throws SuperCsvException
* if there was a general exception while reading/processing
* @throws SuperCsvReflectionException
* if there was an reflection exception while mapping the values to the bean
* @since 1.0
*/
T read(Class clazz, String... nameMapping) throws IOException;
/**
* Reads a row of a CSV file and populates the bean, using the supplied name mapping to map column values to the
* appropriate fields.
*
* @param bean
* the bean to populate
* @param nameMapping
* an array of Strings linking the CSV columns to their corresponding field in the bean (the array length
* should match the number of columns). A null entry in the array indicates that the column
* should be ignored (the field in the bean will be null - or its default value).
* @param
* the bean type
* @return a populated bean or null if EOF
* @throws IOException
* if an I/O error occurred
* @throws IllegalArgumentException
* if nameMapping.length != number of columns read
* @throws NullPointerException
* if bean or nameMapping are null
* @throws SuperCsvException
* if there was a general exception while reading/processing
* @throws SuperCsvReflectionException
* if there was an reflection exception while mapping the values to the bean
* @since 2.2.0
*/
T read(T bean, String... nameMapping) throws IOException;
/**
* Reads a row of a CSV file and populates an instance of the specified class, using the supplied name mapping to
* map column values to the appropriate fields. Before population the data can be further processed by cell
* processors (as with the nameMapping array, each element in the processors array corresponds with a CSV column). A
* null entry in the processors array indicates no further processing is required (the unprocessed String
* value will be set on the bean's field).
*
* @param clazz
* the type to instantiate. If the type is a class then a new instance will be created using the default
* no-args constructor. If the type is an interface, a proxy object which implements the interface will
* be created instead.
* @param nameMapping
* an array of Strings linking the CSV columns to their corresponding field in the bean (the array length
* should match the number of columns). A null entry in the array indicates that the column
* should be ignored (the field in the bean will be null - or its default value).
* @param processors
* an array of CellProcessors used to further process data before it is populated on the bean (each
* element in the processors array corresponds with a CSV column - the number of processors should match
* the number of columns). A null entry indicates no further processing is required (the
* unprocessed String value will be set on the bean's field).
* @param
* the bean type
* @return a populated bean or null if EOF
* @throws IOException
* if an I/O error occurred
* @throws NullPointerException
* if clazz, nameMapping, or processors are null
* @throws SuperCsvConstraintViolationException
* if a CellProcessor constraint failed
* @throws SuperCsvException
* if there was a general exception while reading/processing
* @throws SuperCsvReflectionException
* if there was an reflection exception while mapping the values to the bean
* @since 1.0
*/
T read(Class clazz, String[] nameMapping, CellProcessor... processors) throws IOException;
/**
* Reads a row of a CSV file and populates the bean, using the supplied name mapping to map column values to the
* appropriate fields. Before population the data can be further processed by cell processors (as with the
* nameMapping array, each element in the processors array corresponds with a CSV column). A null entry in
* the processors array indicates no further processing is required (the unprocessed String value will be set on the
* bean's field).
*
* @param bean
* the bean to populate
* @param nameMapping
* an array of Strings linking the CSV columns to their corresponding field in the bean (the array length
* should match the number of columns). A null entry in the array indicates that the column
* should be ignored (the field in the bean will be null - or its default value).
* @param processors
* an array of CellProcessors used to further process data before it is populated on the bean (each
* element in the processors array corresponds with a CSV column - the number of processors should match
* the number of columns). A null entry indicates no further processing is required (the
* unprocessed String value will be set on the bean's field).
* @param
* the bean type
* @return a populated bean or null if EOF
* @throws IOException
* if an I/O error occurred
* @throws NullPointerException
* if bean, nameMapping, or processors are null
* @throws SuperCsvConstraintViolationException
* if a CellProcessor constraint failed
* @throws SuperCsvException
* if there was a general exception while reading/processing
* @throws SuperCsvReflectionException
* if there was an reflection exception while mapping the values to the bean
* @since 2.2.0
*/
T read(T bean, String[] nameMapping, CellProcessor... processors) throws IOException;
}