org.apache.tez.runtime.library.common.sort.impl

Class IFileInputStream

java.lang.Object

java.io.InputStream

org.apache.tez.runtime.library.common.sort.impl.IFileInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public class IFileInputStream
extends InputStream

A checksum input stream, used for IFiles. Used to validate the checksum of files created by IFileOutputStream.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
IFileInputStream(InputStream in, long len) Create a checksum input stream that reads without readAhead.
IFileInputStream(InputStream in, long len, boolean readAhead, int readAheadLength) Create a checksum input stream that reads

Method Summary

Modifier and Type	Method and Description
void	close() Close the input stream.
void	disableChecksumValidation() Disable checksum validation when reading the stream
long	getPosition()
long	getSize()
int	read()
int	read(byte[] b, int off, int len) Read bytes from the stream.
int	readWithChecksum(byte[] b, int off, int len) Read bytes from the stream.
long	skip(long n)

Methods inherited from class java.io.InputStream

available, mark, markSupported, read, reset

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

Constructor Detail

IFileInputStream

public IFileInputStream(InputStream in,
                        long len)

Create a checksum input stream that reads without readAhead.

Parameters:

in -

len -

IFileInputStream

public IFileInputStream(InputStream in,
                        long len,
                        boolean readAhead,
                        int readAheadLength)

Create a checksum input stream that reads

Parameters:

in - The input stream to be verified for checksum.

len - The length of the input stream including checksum bytes.

readAhead - Whether to attempt readAhead for this stream

readAheadLength - Number of bytes to readAhead if it is enabled

Method Detail

close

public void close()
           throws IOException

Close the input stream. Note that we need to read to the end of the stream to validate the checksum.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

getPosition

public long getPosition()

getSize

public long getSize()

read

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

Read bytes from the stream. At EOF, checksum is validated, but the checksum bytes are not passed back in the buffer.

Overrides:

read in class InputStream

Throws:

IOException

readWithChecksum

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

Read bytes from the stream. At EOF, checksum is validated and sent back as the last four bytes of the buffer. The caller should handle these bytes appropriately

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

disableChecksumValidation

public void disableChecksumValidation()

Disable checksum validation when reading the stream