Package org.apache.hadoop.fs

Class FSInputStream

java.lang.Object

java.io.InputStream

org.apache.hadoop.fs.FSInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, PositionedReadable, Seekable

Direct Known Subclasses:

FSInputChecker, FTPInputStream

@Public
@Evolving
public abstract class FSInputStream
extends java.io.InputStream
implements Seekable, PositionedReadable

FSInputStream is a generic old InputStream with a little bit of RAF-style seek ability.

Constructor Summary

Constructors

Constructor	Description
FSInputStream()

Method Summary

Modifier and Type	Method	Description
abstract long	getPos()	Return the current offset from the start of the file
int	read(long position, byte[] buffer, int offset, int length)	Read up to the specified number of bytes, from a given position within a file, and return the number of bytes read.
void	readFully(long position, byte[] buffer)	Read number of bytes equal to the length of the buffer, from a given position within a file.
void	readFully(long position, byte[] buffer, int offset, int length)	Read the specified number of bytes, from a given position within a file.
abstract void	seek(long pos)	Seek to the given offset from the start of the file.
abstract boolean	seekToNewSource(long targetPos)	Seeks a different copy of the data.
java.lang.String	toString()	toString method returns the superclass toString, but if the subclass implements IOStatisticsSource then those statistics are extracted and included in the output.
protected void	validatePositionedReadArgs(long position, byte[] buffer, int offset, int length)	Validation code, available for use in subclasses.

Methods inherited from class java.io.InputStream

available, close, mark, markSupported, nullInputStream, read, read, read, readAllBytes, readNBytes, readNBytes, reset, skip, transferTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.fs.PositionedReadable

maxReadSizeForVectorReads, minSeekForVectorReads, readVectored

Constructor Detail

FSInputStream

public FSInputStream()

Method Detail

seek

public abstract 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.

Specified by:

seek in interface Seekable

Parameters:

pos - offset from the start of the file.

Throws:

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

getPos

public abstract long getPos()
                     throws java.io.IOException

Return the current offset from the start of the file

Specified by:

getPos in interface Seekable

Returns:

offset from the start of the file.

Throws:

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

seekToNewSource

public abstract boolean seekToNewSource(long targetPos)
                                 throws java.io.IOException

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

Specified by:

seekToNewSource in interface Seekable

Parameters:

targetPos - target position.

Returns:

true if found a new source, false otherwise.

Throws:

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

read

public int read(long position,
                byte[] buffer,
                int offset,
                int length)
         throws java.io.IOException

Description copied from interface: PositionedReadable

Read up to the specified number of bytes, from a given position within a file, and return the number of bytes read. This does not change the current offset of a file, and is thread-safe. Warning: Not all filesystems satisfy the thread-safety requirement.

Specified by:

read in interface PositionedReadable

Parameters:

position - position within file

buffer - destination buffer

offset - offset in the buffer

length - number of bytes to read

Returns:

actual number of bytes read; -1 means "none"

Throws:

java.io.IOException - IO problems.

validatePositionedReadArgs

protected void validatePositionedReadArgs(long position,
                                          byte[] buffer,
                                          int offset,
                                          int length)
                                   throws java.io.EOFException

Validation code, available for use in subclasses.

Parameters:

position - position: if negative an EOF exception is raised

buffer - destination buffer

offset - offset within the buffer

length - length of bytes to read

Throws:

java.io.EOFException - if the position is negative

java.lang.IndexOutOfBoundsException - if there isn't space for the amount of data requested.

java.lang.IllegalArgumentException - other arguments are invalid.

readFully

public void readFully(long position,
                      byte[] buffer,
                      int offset,
                      int length)
               throws java.io.IOException

Description copied from interface: PositionedReadable

Read the specified number of bytes, from a given position within a file. This does not change the current offset of a file, and is thread-safe. Warning: Not all filesystems satisfy the thread-safety requirement.

Specified by:

readFully in interface PositionedReadable

Parameters:

position - position within file

buffer - destination buffer

offset - offset in the buffer

length - number of bytes to read

Throws:

java.io.IOException - IO problems.

java.io.EOFException - the end of the data was reached before the read operation completed

readFully

public void readFully(long position,
                      byte[] buffer)
               throws java.io.IOException

Description copied from interface: PositionedReadable

Read number of bytes equal to the length of the buffer, from a given position within a file. This does not change the current offset of a file, and is thread-safe. Warning: Not all filesystems satisfy the thread-safety requirement.

Specified by:

readFully in interface PositionedReadable

Parameters:

position - position within file

buffer - destination buffer

Throws:

java.io.IOException - IO problems.

java.io.EOFException - the end of the data was reached before the read operation completed

toString

public java.lang.String toString()

toString method returns the superclass toString, but if the subclass implements IOStatisticsSource then those statistics are extracted and included in the output. That is: statistics of subclasses are automatically reported.

Overrides:

toString in class java.lang.Object

Returns:

a string value.