org.nerd4j.csv.reader.CSVReadOutcome Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nerd4j-csv Show documentation

CSV manipulation library.

There is a newer version: 1.2.0

/*
 * #%L
 * Nerd4j CSV
 * %%
 * Copyright (C) 2013 Nerd4j
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as 
 * published by the Free Software Foundation, either version 3 of the 
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public 
 * License along with this program.  If not, see
 * .
 * #L%
 */
package org.nerd4j.csv.reader;

import org.nerd4j.csv.CSVProcessContext;


/**
 * Represents the outcome of a CSV read operation performed
 * by the {@link CSVReader#read()} method.
 * 
 * 
 *  This object contains the following elements:
 *  

 *   The data model corresponding to the CSV record read;
 *   The execution context of the reading operation.
 *  
 * 
 * 
 * @param  type of the data model representing the CSV record.
 * 
 * @author Nerd4j Team
 */
public interface CSVReadOutcome
{
    
    /**
     * Returns the data model corresponding to the CSV record read.
     * 
     *  If the CSV source is empty or an error occurred the model
     *  is null.
     * 
     * 
     * @return the data model corresponding to the CSV record read.
     */
    public M getModel();
    
    /**
     * Returns the reading execution context.
     * 
     *  This object contains some information about the progress
     *  of the reading.
     * 
     * 
     *  IMPORTANT for performance reasons there is only one
     *                   instance of the execution context. So the
     *                   internal values of this object may vary
     *                   during execution.
     * 
     * @return the reading execution context.
     */
    public CSVProcessContext getCSVReadingContext();
    
}