H2 Database Engine 2.3.232 · org.h2.store.RangeInputStream

Modifier and Type	Field and Description
private long	limit

Access	Constructor and Description
public	RangeInputStream(InputStream source stream in, long offset of the range offset, long length of the range limit) Creates new instance of range input stream.

Method Summary

Modifier and Type	Method and Description
public int	available() Overrides java.io.FilterInputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.
public void	close() Overrides java.io.FilterInputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
public void	mark(int the maximum limit of bytes that can be read before the mark position becomes invalid. readlimit) Overrides java.io.FilterInputStream.mark. Marks the current position in this input stream.
public boolean	markSupported() Overrides java.io.FilterInputStream.markSupported. Tests if this input stream supports the `mark` and `reset` methods.
public int	read() Overrides java.io.FilterInputStream.read. Reads the next byte of data from the input stream.
public int	read(byte[] the buffer into which the data is read. b, int the start offset in array `b` at which the data is written. off, int the maximum number of bytes to read. len) Overrides java.io.FilterInputStream.read. Reads up to `len` bytes of data from this input stream into an array of bytes.
public synchronized void	reset() Overrides java.io.FilterInputStream.reset. Repositions this stream to the position at the time the `mark` method was last called on this input stream.
public long	skip(long the number of bytes to be skipped. n) Overrides java.io.FilterInputStream.skip. Skips over and discards `n` bytes of data from the input stream.

Inherited from java.io.FilterInputStream:: read

limit	back to summary
private long limit

RangeInputStream	back to summary
public RangeInputStream(InputStream in, long offset, long limit) throws IOException Creates new instance of range input stream. Parameters in:InputStream source stream offset:long offset of the range limit:long length of the range Exceptions IOException: on I/O exception during seeking to the specified offset

Method Detail

available	back to summary
public int available() throws IOException Overrides java.io.FilterInputStream.available. Doc from java.io.FilterInputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. Returns:int an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking. Annotations @Override Exceptions IOException: if an I/O error occurs.

available

back to summary

public int available() throws IOException

Overrides java.io.FilterInputStream.available.

Doc from java.io.FilterInputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Returns:int

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

close	back to summary
public void close() throws IOException Overrides java.io.FilterInputStream.close. Implements java.io.Closeable.close. Doc from java.io.FilterInputStream.close. Closes this input stream and releases any system resources associated with the stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.FilterInputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.FilterInputStream.close.

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

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

mark back to summary

mark	back to summary
public void mark(int readlimit) Overrides java.io.FilterInputStream.mark. Doc from java.io.FilterInputStream.mark. Marks the current position in this input stream. A subsequent call to the `reset` method repositions this stream at the last marked position so that subsequent reads re-read the same bytes. The `readlimit` argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated. Parameters readlimit:int the maximum limit of bytes that can be read before the mark position becomes invalid. Annotations @Override

public void mark(int readlimit)

Overrides java.io.FilterInputStream.mark.

Doc from java.io.FilterInputStream.mark.

Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.

The readlimit argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated.

Parameters

readlimit:int: the maximum limit of bytes that can be read before the mark position becomes invalid.

Annotations

@Override

markSupported back to summary

markSupported	back to summary
public boolean markSupported() Overrides java.io.FilterInputStream.markSupported. Doc from java.io.FilterInputStream.markSupported. Tests if this input stream supports the `mark` and `reset` methods. Returns:boolean `true` if this stream type supports the `mark` and `reset` method; `false` otherwise. Annotations @Override

public boolean markSupported()

Overrides java.io.FilterInputStream.markSupported.

Doc from java.io.FilterInputStream.markSupported.

Tests if this input stream supports the mark and reset methods.

Returns:boolean

true if this stream type supports the mark and reset method; false otherwise.

Annotations

@Override

read back to summary

read	back to summary
public int read() throws IOException Overrides java.io.FilterInputStream.read. Doc from java.io.FilterInputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Overrides java.io.FilterInputStream.read.

Doc from java.io.FilterInputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] b, int off, int len) throws IOException Overrides java.io.FilterInputStream.read. Doc from java.io.FilterInputStream.read. Reads up to `len` bytes of data from this input stream into an array of bytes. If `len` is not zero, the method blocks until some input is available; otherwise, no bytes are read and `0` is returned. Parameters b:byte[] the buffer into which the data is read. off:int the start offset in array `b` at which the data is written. len:int the maximum number of bytes to read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

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

Overrides java.io.FilterInputStream.read.

Doc from java.io.FilterInputStream.read.

Reads up to len bytes of data from this input stream into an array of bytes. If len is not zero, the method blocks until some input is available; otherwise, no bytes are read and 0 is returned.

Parameters

b:byte[]: the buffer into which the data is read.
off:int: the start offset in array b at which the data is written.
len:int: the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

reset back to summary

reset	back to summary
public synchronized void reset() throws IOException Overrides java.io.FilterInputStream.reset. Doc from java.io.FilterInputStream.reset. Repositions this stream to the position at the time the `mark` method was last called on this input stream. Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser. Annotations @Override Exceptions IOException: if this stream has not been marked or if the mark has been invalidated.

public synchronized void reset() throws IOException

Overrides java.io.FilterInputStream.reset.

Doc from java.io.FilterInputStream.reset.

Repositions this stream to the position at the time the mark method was last called on this input stream.

Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser.

Annotations

@Override

Exceptions

IOException:: if this stream has not been marked or if the mark has been invalidated.

skip back to summary

skip	back to summary
public long skip(long n) throws IOException Overrides java.io.FilterInputStream.skip. Doc from java.io.FilterInputStream.skip. Skips over and discards `n` bytes of data from the input stream. The `skip` method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly `0`. The actual number of bytes skipped is returned. Parameters n:long the number of bytes to be skipped. Returns:long the actual number of bytes skipped. Annotations @Override Exceptions IOException: if `in.skip(n)` throws an IOException.

public long skip(long n) throws IOException

Overrides java.io.FilterInputStream.skip.

Doc from java.io.FilterInputStream.skip.

Skips over and discards n bytes of data from the input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. The actual number of bytes skipped is returned.

Parameters

n:long: the number of bytes to be skipped.

Returns:long

the actual number of bytes skipped.

Annotations

@Override

Exceptions

IOException:: if in.skip(n) throws an IOException.

public final Class RangeInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail