AbstractReader.java

/**
 * Copyright 2014, Emory University
 * 
 * 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 edu.emory.clir.clearnlp.reader;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;

import edu.emory.clir.clearnlp.util.IOUtils;

/**
 * @since 3.0.0
 * @author Jinho D. Choi ({@code jinho.choi@emory.edu})
 */
abstract public class AbstractReader<T>
{
	protected BufferedReader b_reader;
	protected InputStream    f_in;
	private   TReader        r_type;
	
	public AbstractReader(TReader type)
	{
		setReaderType(type);
	}
	
	/** @param in internally wrapped by {@code new BufferedReader(new InputStreamReader(in));}. */
	public AbstractReader(InputStream in)
	{
		open(in);
	}
	
	/** @param in internally wrapped by {@code new BufferedReader(new InputStreamReader(in));}. */
	public void open(InputStream in)
	{
		b_reader = IOUtils.createBufferedReader(in);
		f_in = in;
	}
	
	public void close()
	{
		try
		{
			b_reader.close();
		}
		catch (IOException e) {e.printStackTrace();}
	}
	
	public InputStream getInputStream()
	{
		return f_in;
	}
	
	public TReader getReaderType()
	{
		return r_type;
	}
	
	public void setReaderType(TReader type)
	{
		r_type = type;
	}

	public boolean isReaderType(TReader type)
	{
		return r_type == type;
	}
	
	/** @return the next item if exists; otherwise, {@code null}. */
	abstract public T next();
	
	abstract public AbstractReader<T> clone();
}