org.apache.paimon.fs

Class SeekableInputStream

java.lang.Object

java.io.InputStream

org.apache.paimon.fs.SeekableInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ByteArraySeekableStream, LocalFileIO.LocalSeekableInputStream, SeekableInputStreamWrapper

@Public
public abstract class SeekableInputStream
extends InputStream

SeekableInputStream provides seek methods.

Since:

0.4.0

Constructor Summary

Constructors

Constructor and Description
SeekableInputStream()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Closes this input stream and releases any system resources associated with the stream.
abstract long	getPos() Gets the current position in the input stream.
abstract int	read(byte[] b, int off, int len) Reads up to len bytes of data from the input stream into an array of bytes.
abstract void	seek(long desired) Seek to the given offset from the start of the file.

Methods inherited from class java.io.InputStream

available, mark, markSupported, read, read, reset, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SeekableInputStream

public SeekableInputStream()

Method Detail

seek

public abstract void seek(long desired)
                   throws IOException

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 stream.

Parameters:

desired - the desired offset

Throws:

IOException - Thrown if an error occurred while seeking inside the input stream.

getPos

public abstract long getPos()
                     throws IOException

Gets the current position in the input stream.

Returns:

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.

read

public abstract int read(byte[] b,
                         int off,
                         int len)
                  throws IOException

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

Overrides:

read in class InputStream

Throws:

IOException

close

public abstract void close()
                    throws IOException

Closes this input stream and releases any system resources associated with the stream.

The close method of InputStream does nothing.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException - if an I/O error occurs.