Open Source Repository

Home /supercsv/super-csv-2.0.0 | Repository Home



org/supercsv/io/ICsvBeanReader.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 <tt>null</tt> entry in the array indicates that the column
   *            should be ignored (the field in the bean will be null - or its default value).
   @return a populated bean or null if EOF
   @throws IOException
   *             if an I/O error occurred
   @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> T read(Class<T> clazz, String... nameMappingthrows 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
   <tt>null</tt> 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 <tt>null</tt> 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 <tt>null</tt> entry indicates no further processing is required (the
   *            unprocessed String value will be set on the bean's field).
   @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> T read(Class<T> clazz, String[] nameMapping, CellProcessor... processorsthrows IOException;
}