org.nerd4j.csv.parser.CSVParser 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.parser;

import java.io.Closeable;
import java.io.IOException;
import java.io.Reader;

/**
 * CSVParser reads character data from a {@link Reader}, parsing and
 * tokenizing them into {@link CSVToken}.
 * 
 * 
 *  After usage it should be closed to permit resource release.
 * 
 * 
 * @author Nerd4j Team
 */
public interface CSVParser extends Closeable
{

    
	/**
	 * Returns last read {@link CSVToken}. If {@link #read()} wasn't called
	 * before {@code null} will be returned.
	 * 
	 * @return last read {@link CSVToken}.
	 */
	public CSVToken getCurrentToken();
	
	/**
	 * Returns last read field value. If {@link #read()} wasn't called before or
	 * {@link #getCurrentToken()} isn't {@link CSVToken#FIELD} {@code null} will
	 * be returned.
	 * 
	 * @return last read field value.
	 */
	public String getCurrentValue();
	
	/**
	 * Read the next {@link CSVToken} and returns it. The result
	 * {@link CSVToken} will be returned from {@link #getCurrentToken()} too.
	 * 
	 * @return next read {@link CSVToken}.
	 * @throws IOException if an error occurs while parsing data.
	 */
	public CSVToken read() throws IOException;
	
	/**
	 * Read the next {@link CSVToken} and returns it. The result
	 * {@link CSVToken} will be returned from {@link #getCurrentToken()} too.
	 * 
	 * The method {@link #getCurrentValue()} won't return any value.
	 * 
	 * 
	 * @return next read {@link CSVToken}.
	 * @throws IOException if an error occurs while parsing data.
	 */
	public CSVToken skip() throws IOException;
	
}