org.apache.hadoop.hbase.io

Class BoundedDelegatingInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.hadoop.hbase.io.DelegatingInputStream

org.apache.hadoop.hbase.io.BoundedDelegatingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

@InterfaceAudience.Private
public class BoundedDelegatingInputStream
extends DelegatingInputStream

This is a stream that will only supply bytes from its delegate up to a certain limit. When there is an attempt to set the position beyond that it will signal that the input is finished.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	limit
protected long	pos

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
BoundedDelegatingInputStream(InputStream in, long limit)

Method Summary

Modifier and Type	Method and Description
int	available()
int	read() Call the delegate's read() method if the current position is less than the limit.
int	read(byte[] b, int off, int len) Call the delegate's read(byte[], int, int) method if the current position is less than the limit.
void	setDelegate(InputStream in, long limit)
long	skip(long len) Call the delegate's skip(long) method.

Methods inherited from class org.apache.hadoop.hbase.io.DelegatingInputStream

getDelegate, setDelegate

Methods inherited from class java.io.FilterInputStream

close, mark, markSupported, read, reset

Methods inherited from class java.lang.Object

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

Field Detail

limit

protected long limit

pos

protected long pos

Constructor Detail

BoundedDelegatingInputStream

public BoundedDelegatingInputStream(InputStream in,
                                    long limit)

Method Detail

setDelegate

public void setDelegate(InputStream in,
                        long limit)

read

public int read()
         throws IOException

Call the delegate's read() method if the current position is less than the limit.

Overrides:

read in class FilterInputStream

Returns:

the byte read or -1 if the end of stream or the limit has been reached.

Throws:

IOException

read

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

Call the delegate's read(byte[], int, int) method if the current position is less than the limit.

Overrides:

read in class FilterInputStream

Parameters:

b - read buffer

off - Start offset

len - The number of bytes to read

Returns:

the number of bytes read or -1 if the end of stream or the limit has been reached.

Throws:

IOException

skip

public long skip(long len)
          throws IOException

Call the delegate's skip(long) method.

Overrides:

skip in class FilterInputStream

Parameters:

len - the number of bytes to skip

Returns:

the actual number of bytes skipped

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class FilterInputStream

Returns:

the remaining bytes within the bound if the current position is less than the limit, or 0 otherwise.

Throws:

IOException