Package org.apache.hadoop.fs

Interface Seekable

All Known Implementing Classes:

BlockDecompressorStream, BufferedFSInputStream, CompressionInputStream, CryptoFSDataInputStream, CryptoInputStream, DecompressorStream, FSDataInputStream, FSInputChecker, FSInputStream, FTPInputStream, PassthroughCodec.PassthroughDecompressorStream, SplitCompressionInputStream

@Public
@Evolving
public interface Seekable

Stream that permits seeking.

Method Summary

Modifier and Type	Method	Description
long	getPos()	Return the current offset from the start of the file
void	seek(long pos)	Seek to the given offset from the start of the file.
boolean	seekToNewSource(long targetPos)	Seeks a different copy of the data.

Method Detail

seek

void seek(long pos)
   throws java.io.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 file.

Parameters:

pos - offset from the start of the file.

Throws:

java.io.IOException - raised on errors performing I/O.

getPos

long getPos()
     throws java.io.IOException

Return the current offset from the start of the file

Returns:

offset from the start of the file.

Throws:

java.io.IOException - raised on errors performing I/O.

seekToNewSource

@Private
boolean seekToNewSource(long targetPos)
                 throws java.io.IOException

Seeks a different copy of the data. Returns true if found a new source, false otherwise.

Parameters:

targetPos - target position.

Returns:

true if found a new source, false otherwise.

Throws:

java.io.IOException - raised on errors performing I/O.