java.edu.iu.dsc.tws.api.data.FSDataInputStream Maven / Gradle / Ivy
// 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.iu.dsc.tws.api.data;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
/**
* Interface for a data input stream to a file on a {@link FileSystem}.
*
*
This extends the {@link InputStream} with methods for accessing
* the stream's {@link #getPos() current position} and
* {@link #seek(long) seeking} to a desired position.
*/
public abstract class FSDataInputStream extends InputStream {
/**
* Seek to the given offset from the start of the file. The next read() will be from that location.
* Can't seek past the end of the file.
*
* @param desired the desired offset
* @throws IOException Thrown if an error occurred while seeking inside the input stream.
*/
public abstract void seek(long desired) throws IOException;
/**
* Gets the current position in the input stream.
*
* @return current position in the input stream
* @throws IOException Thrown if an I/O error occurred in the underlying stream
* implementation while accessing the stream's position.
*/
public abstract long getPos() throws IOException;
public abstract Reader getReader() throws FileNotFoundException;
}