org.databene.formats.DataSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of databene-formats Show documentation

'Databene Formats' is an open source software library for supporting data file and other formats like CSV, fixed width files, XLS, Properties and Regex. It is designed for multithreaded use and high performance.

The newest version!

/*
 * Copyright (C) 2011-2015 Volker Bergmann ([email protected]).
 * All rights reserved.
 *
 * 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.databene.formats;

import java.io.Closeable;

/**
 * Interface for classes that provide data access by {@link DataIterator}s. 
 * Implementors are expected to be thread-safe.
 * Created: 24.07.2011 08:48:26
 * @param  the type of data to iterate
 * @since 0.6.0
 * @author Volker Bergmann
 */
public interface DataSource extends Closeable {
	
	/** Returns the type of the iterated objects. 
	 * @return the type of data to iterate */
	Class getType();
	
	/** Creates a {@link DataIterator} for iterating the available data items. 
	 * @return an iterator to iterate the available data */
	DataIterator iterator();
	
	/** Closes the data source */
	@Override
	void close();
	
}