Open Source Repository

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



org/supercsv/io/AbstractTokenizer.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 java.io.LineNumberReader;
import java.io.Reader;
import java.util.List;

import org.supercsv.prefs.CsvPreference;

/**
 * Defines the standard behaviour of a Tokenizer. Extend this class if you want the line-reading functionality of the
 * default {@link Tokenizer}, but want to define your own implementation of {@link #readColumns(List)}.
 
 @author James Bassett
 @since 2.0.0
 */
public abstract class AbstractTokenizer implements ITokenizer {
  
  private final CsvPreference preferences;
  
  private final LineNumberReader lnr;
  
  /**
   * Constructs a new <tt>AbstractTokenizer</tt>, which reads the CSV file, line by line.
   
   @param reader
   *            the reader
   @param preferences
   *            the CSV preferences
   @throws NullPointerException
   *             if reader or preferences is null
   */
  public AbstractTokenizer(final Reader reader, final CsvPreference preferences) {
    ifreader == null ) {
      throw new NullPointerException("reader should not be null");
    }
    ifpreferences == null ) {
      throw new NullPointerException("preferences should not be null");
    }
    this.preferences = preferences;
    lnr = new LineNumberReader(reader);
  }
  
  /**
   * Closes the underlying reader.
   */
  public void close() throws IOException {
    lnr.close();
  }
  
  /**
   * {@inheritDoc}
   */
  public int getLineNumber() {
    return lnr.getLineNumber();
  }
  
  /**
   * Reads a line of text. Whenever a line terminator is read the current line number is incremented.
   
   @return A String containing the contents of the line, not including any line termination characters, or
   *         <tt>null</tt> if the end of the stream has been reached
   @throws IOException
   *             If an I/O error occurs
   */
  protected String readLine() throws IOException {
    return lnr.readLine();
  }
  
  /**
   * Gets the CSV preferences.
   
   @return the preferences
   */
  protected CsvPreference getPreferences() {
    return preferences;
  }
  
}