Top Description Fields Constructors Methods
org.glassfish.grizzly.utils

public Class BufferInputStream

extends InputStream
Class Inheritance
Imports
java.io.IOException, .InputStream, org.glassfish.grizzly.Buffer, org.glassfish.grizzly.memory.Buffers
InputStream implementation over Grizzly Buffer.
Author
Alexey Stashok

Field Summary

Modifier and TypeField and Description
private final Buffer
buffer

private final boolean
isMovingPosition

private final int
limit

private int
position

Constructor Summary

AccessConstructor and Description
public
BufferInputStream(final Buffer buffer)

Create the InputStream over Grizzly Buffer.

public
BufferInputStream(final Buffer buffer, final int position, final int limit)

Create the InputStream over Grizzly Buffer.

Method Summary

Modifier and TypeMethod and Description
public int
available()

Overrides java.io.InputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected.

public int
read()

Implements abstract java.io.InputStream.read.

Reads the next byte of data from the input stream.

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

Overrides java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes.

public long
skip(final long n)

Overrides java.io.InputStream.skip.

Skips over and discards n bytes of data from this input stream.

Inherited from java.io.InputStream:
closemarkmarkSupportednullInputStreamreadreadAllBytesreadNBytesreadNBytesresetskipNBytestransferTo

Field Detail

bufferback to summary
private final Buffer buffer
isMovingPositionback to summary
private final boolean isMovingPosition
limitback to summary
private final int limit
positionback to summary
private int position

Constructor Detail

BufferInputStreamback to summary
public BufferInputStream(final Buffer buffer)

Create the InputStream over Grizzly Buffer. Constructed BufferInputStream read operations will affect the passed Buffer position, which means each BufferInputStream read operation will shift Buffer's position by number of bytes, which were read.

BufferInputStreamback to summary
public BufferInputStream(final Buffer buffer, final int position, final int limit)

Create the InputStream over Grizzly Buffer. Constructed BufferInputStream read operations will *not* affect the passed Buffer position, which means the passed Buffer position will never be changed during BufferInputStream

Method Detail

availableback to summary
public int available() throws IOException

Overrides java.io.InputStream.available.

Doc from java.io.InputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on 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.

Note that while some implementations of InputStream will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream.

A subclass's implementation of this method may choose to throw an IOException if this input stream has been closed by invoking the close() method.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readback to summary
public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.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.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readback to summary
public int read(final byte[] b, final int off, final int len) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Annotations
@Override
Exceptions
IOException:
If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.
skipback to summary
public long skip(final long n) throws IOException

Overrides java.io.InputStream.skip.

Doc from java.io.InputStream.skip.

Skips over and discards n bytes of data from this input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If n is negative, the skip method for class InputStream always returns 0, and no bytes are skipped. Subclasses may handle the negative value differently.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.