AbstractReadBuffer.AbstractBufferInput (Java API Reference for Oracle® Coherence Community Edition)

java.lang.Object
- java.io.InputStream
- - com.tangosol.io.AbstractReadBuffer.AbstractBufferInput

All Implemented Interfaces:

com.oracle.coherence.common.io.InputStreaming, ReadBuffer.BufferInput, Closeable, DataInput, AutoCloseable

Direct Known Subclasses:

AbstractByteArrayReadBuffer.ByteArrayBufferInput, ByteBufferReadBuffer.ByteBufferInput, MultiBufferReadBuffer.MultiBufferInput

Enclosing class:

AbstractReadBuffer
```
public class AbstractReadBuffer.AbstractBufferInput
extends InputStream
implements ReadBuffer.BufferInput
```
This is an implementation of the BufferInput interface that delegates its work back to its ReadBuffer.
This implementation extends InputStream, but only so that it can be passed to anything that takes an InputStream.

Constructor Summary

Constructors
Constructor and Description

AbstractBufferInput()
Default constructor.

Constructors
Constructor and Description
`AbstractBufferInput()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`adjustOffsetInternal(int cb)` Adjust the internal stream offset.
`int`	`available()` Returns the number of bytes that can be read (or skipped over) from this input stream without causing a blocking I/O condition to occur.
`void`	`close()` Close the InputStream and release any system resources associated with it.
`protected String`	`convertUTF(int of, int cb)` Convert a UTF-8 encoded section of the binary stream into a String.
`ReadBuffer`	`getBuffer()` Get the ReadBuffer object that this BufferInput is reading from.
`protected char[]`	`getCharBuf(int cchMax)` Obtain a temp buffer used to avoid allocations when building Strings from UTF binary data.
`protected int`	`getMarkInternal()` Obtain the offset of the stream mark.
`int`	`getOffset()` Determine the current offset of this BufferInput within the underlying ReadBuffer.
`void`	`mark(int cbReadLimit)` Marks the current read position in the InputStream in order to support the stream to be later "rewound" (using the `InputStreaming.reset()` method) to the current position.
`boolean`	`markSupported()` Determine if this InputStream supports the `ReadBuffer.BufferInput.mark(int)` and `InputStreaming.reset()` methods.
`int`	`read()` Read the next byte of data from the InputStream.
`int`	`read(byte[] ab)` Read some number of bytes from the input stream and store them into the passed array `ab`.
`int`	`read(byte[] ab, int of, int cb)` Read up to `cb` bytes from the input stream and store them into the passed array `ab` starting at offset `of`.
`boolean`	`readBoolean()` Read a boolean value.
`ReadBuffer`	`readBuffer(int cb)` Read `cb` bytes and return them as a ReadBuffer object.
`byte`	`readByte()` Read a byte value.
`char`	`readChar()` Read a char value.
`double`	`readDouble()` Read a double value.
`float`	`readFloat()` Read a float value.
`void`	`readFully(byte[] ab)` Read `ab.length` bytes and store them in `ab`.
`void`	`readFully(byte[] ab, int of, int cb)` Read `cb` bytes and store them in `ab` starting at offset `of`.
`int`	`readInt()` Read an int value.
`String`	`readLine()` Reads the next "line" of text.
`long`	`readLong()` Read a long value.
`int`	`readPackedInt()` Read an int value using a variable-length storage format as described by `WriteBuffer.BufferOutput.writePackedInt(int)`.
`long`	`readPackedLong()` Read a long value using a variable-length storage format as described by `WriteBuffer.BufferOutput.writePackedLong(long)`.
`String`	`readSafeUTF()` Read a variable-length encoded UTF packed String.
`short`	`readShort()` Read a short value.
`int`	`readUnsignedByte()` Read an unsigned byte value.
`int`	`readUnsignedShort()` Read an unsigned short value.
`String`	`readUTF()` Reads a String value.
`protected String`	`readUTF(int cb)` Reads the specified-length UTF data and converts it to a String value.
`void`	`reset()` Rewind this stream to the position at the time the `InputStreaming.mark(int)` method was last called on this InputStream.
`protected void`	`setMarkInternal(int of)` Update the internal stream mark.
`void`	`setOffset(int of)` Specify the offset of the next byte to read from the underlying ReadBuffer.
`protected void`	`setOffsetInternal(int of)` Update the internal stream offset.
`long`	`skip(long cb)` Skips over up to the specified number of bytes of data from this InputStream.
`int`	`skipBytes(int cb)` Skips over up to the specified number of bytes of data.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractBufferInput
```
public AbstractBufferInput()
```
    Default constructor.
- Method Detail
  - read
```
public int read()
         throws IOException
```
    Read the next byte of data from the InputStream. The value byte is returned as an int in the range 0 to 255. If 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.
    
    Specified by:
    
    read in interface com.oracle.coherence.common.io.InputStreaming
    
    Specified by:
    
    read in class InputStream
    
    Returns:
    
    the next byte of data, or -1 if the end of the stream has been reached
    
    Throws:
    
    IOException - if an I/O error occurs
  - read
```
public int read(byte[] ab)
         throws IOException
```
    Read some number of bytes from the input stream and store them into the passed array ab. The number of bytes actually read is returned.
    This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
    
    Specified by:
    
    read in interface com.oracle.coherence.common.io.InputStreaming
    
    Overrides:
    
    read in class InputStream
    
    Parameters:
    
    ab - the array to store the bytes which are read from the stream
    
    Returns:
    
    the number of bytes read from the stream, or -1 if no bytes were read from the stream because the end of the stream had been reached
    
    Throws:
    
    IOException - if an I/O error occurs
  - read
```
public int read(byte[] ab,
                int of,
                int cb)
         throws IOException
```
    Read up to cb bytes from the input stream and store them into the passed array ab starting at offset of. The number of bytes actually read is returned.
    This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
    
    Specified by:
    
    read in interface com.oracle.coherence.common.io.InputStreaming
    
    Overrides:
    
    read in class InputStream
    
    Parameters:
    
    ab - the array to store the bytes which are read from the stream
    
    of - the offset into the array that the read bytes will be stored
    
    cb - the maximum number of bytes to read
    
    Returns:
    
    the number of bytes read from the stream, or -1 if no bytes were read from the stream because the end of the stream had been reached
    
    Throws:
    
    IOException - if an I/O error occurs
  - skip
```
public long skip(long cb)
          throws IOException
```
    Skips over up to the specified number of bytes of data from this InputStream. The number of bytes actually skipped over may be fewer than the number specified to skip, and may even be zero; this can be caused by an end-of-file condition, but can also occur even when there is data remaining in the InputStream. As a result, the caller should check the return value from this method, which indicates the actual number of bytes skipped.
    
    Specified by:
    
    skip in interface com.oracle.coherence.common.io.InputStreaming
    
    Overrides:
    
    skip in class InputStream
    
    Parameters:
    
    cb - the maximum number of bytes to skip over
    
    Returns:
    
    the actual number of bytes that were skipped over
    
    Throws:
    
    IOException - if an I/O error occurs
  - available
```
public int available()
              throws IOException
```
    Returns the number of bytes that can be read (or skipped over) from this input stream without causing a blocking I/O condition to occur. This method reflects the assumed implementation of various buffering InputStreams, which can guarantee non-blocking reads up to the extent of their buffers, but beyond that the read operations will have to read from some underlying (and potentially blocking) source.
    BufferInput implementations must implement this method to return the extent of the buffer that has not yet been read; in other words, the entire un-read portion of the buffer must be available.
    
    Specified by:
    
    available in interface com.oracle.coherence.common.io.InputStreaming
    
    Specified by:
    
    available in interface ReadBuffer.BufferInput
    
    Overrides:
    
    available in class InputStream
    
    Returns:
    
    the number of bytes that can be read from this InputStream without blocking
    
    Throws:
    
    IOException - if an I/O error occurs
  - close
```
public void close()
           throws IOException
```
    Close the InputStream and release any system resources associated with it.
    BufferInput implementations do not pass this call down onto an underlying stream, if any.
    
    Specified by:
    
    close in interface com.oracle.coherence.common.io.InputStreaming
    
    Specified by:
    
    close in interface ReadBuffer.BufferInput
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class InputStream
    
    Throws:
    
    IOException - if an I/O error occurs
  - mark
```
public void mark(int cbReadLimit)
```
    Marks the current read position in the InputStream in order to support the stream to be later "rewound" (using the InputStreaming.reset() method) to the current position. The caller passes in the maximum number of bytes that it expects to read before calling the InputStreaming.reset() method, thus indicating the upper bounds of the responsibility of the stream to be able to buffer what it has read in order to support this functionality.
    BufferInput implementations ignore the cbReadLimit; they must support an unlimited read limit, since they appear to the user as an input stream on top of a fully realized read buffer.
    
    Specified by:
    
    mark in interface com.oracle.coherence.common.io.InputStreaming
    
    Specified by:
    
    mark in interface ReadBuffer.BufferInput
    
    Overrides:
    
    mark in class InputStream
    
    Parameters:
    
    cbReadLimit - the maximum number of bytes that caller expects the InputStream to be able to read before the mark position becomes invalid
  - reset
```
public void reset()
           throws IOException
```
    Rewind this stream to the position at the time the InputStreaming.mark(int) method was last called on this InputStream. If the InputStream cannot fulfill this contract, it should throw an IOException.
    
    Specified by:
    
    reset in interface com.oracle.coherence.common.io.InputStreaming
    
    Overrides:
    
    reset in class InputStream
    
    Throws:
    
    IOException - if an I/O error occurs, for example if this has not been marked or if the mark has been invalidated
  - markSupported
```
public boolean markSupported()
```
    Determine if this InputStream supports the ReadBuffer.BufferInput.mark(int) and InputStreaming.reset() methods.
    BufferInput implementations must support the ReadBuffer.BufferInput.mark(int) and InputStreaming.reset() methods, so this method always returns true.
    
    Specified by:
    
    markSupported in interface com.oracle.coherence.common.io.InputStreaming
    
    Specified by:
    
    markSupported in interface ReadBuffer.BufferInput
    
    Overrides:
    
    markSupported in class InputStream
    
    Returns:
    
    true if this InputStream supports the mark and reset method; false otherwise
  - readFully
```
public void readFully(byte[] ab)
               throws IOException
```
    Read ab.length bytes and store them in ab.
    This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
    
    Specified by:
    
    readFully in interface ReadBuffer.BufferInput
    
    Specified by:
    
    readFully in interface DataInput
    
    Parameters:
    
    ab - the array to store the bytes which are read from the stream
    
    Throws:
    
    EOFException - if the stream is exhausted before the number of bytes indicated by the array length could be read
    
    IOException - if an I/O error occurs
  - readFully
```
public void readFully(byte[] ab,
                      int of,
                      int cb)
               throws IOException
```
    Read cb bytes and store them in ab starting at offset of.
    This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
    
    Specified by:
    
    readFully in interface ReadBuffer.BufferInput
    
    Specified by:
    
    readFully in interface DataInput
    
    Parameters:
    
    ab - the array to store the bytes which are read from the stream
    
    of - the offset into the array that the read bytes will be stored
    
    cb - the maximum number of bytes to read
    
    Throws:
    
    EOFException - if the stream is exhausted before the number of bytes indicated by the array length could be read
    
    IOException - if an I/O error occurs
  - skipBytes
```
public int skipBytes(int cb)
              throws IOException
```
    Skips over up to the specified number of bytes of data. The number of bytes actually skipped over may be fewer than the number specified to skip, and may even be zero; this can be caused by an end-of-file condition, but can also occur even when there is data remaining to be read. As a result, the caller should check the return value from this method, which indicates the actual number of bytes skipped.
    
    Specified by:
    
    skipBytes in interface ReadBuffer.BufferInput
    
    Specified by:
    
    skipBytes in interface DataInput
    
    Parameters:
    
    cb - the maximum number of bytes to skip over
    
    Returns:
    
    the actual number of bytes that were skipped over
    
    Throws:
    
    IOException - if an I/O error occurs
  - readBoolean
```
public boolean readBoolean()
                    throws IOException
```
    Read a boolean value.
    This method is the counterpart for the DataOutput.writeBoolean(boolean) method.
    
    Specified by:
    
    readBoolean in interface ReadBuffer.BufferInput
    
    Specified by:
    
    readBoolean in interface DataInput
    
    Returns:
    
    either true or false
    
    Throws:
    
    EOFException - if the value could not be read because no more data remains to be read
    
    IOException - if an I/O error occurs
  - readByte
```
public byte readByte()
              throws IOException
```
    Read a byte value.
    This method is the counterpart for the DataOutput.writeByte(int) method.
    
    Specified by:
    
    readByte in interface ReadBuffer.BufferInput
    
    Specified by:
    
    readByte in interface DataInput
    
    Returns:
    
    a byte value
    
    Throws:
    
    EOFException - if the value could not be read because no more data remains to be read
    
    IOException - if an I/O error occurs
  - readUnsignedByte
```
public int readUnsignedByte()
                     throws IOException
```
    Read an unsigned byte value.
    This method is the counterpart for the DataOutput.writeByte(int) method when it is used with unsigned 8-bit values.
    
    Specified by:
    
    readUnsignedByte in interface ReadBuffer.BufferInput
    
    Specified by:
    
    readUnsignedByte in interface DataInput
    
    Returns:
    
    an int value in the range 0x00 to 0xFF
    
    Throws:
    
    EOFException - if the value could not be read because no more data remains to be read
    
    IOException - if an I/O error occurs
  - readShort
```
public short readShort()
                throws IOException
```
    Read a short value.
    This method is the counterpart for the DataOutput.writeShort(int) method.
    
    Specified by:
    
    readShort in interface ReadBuffer.BufferInput
    
    Specified by:
    
    readShort in interface DataInput
    
    Returns:
    
    a short value
    
    Throws:
    
    EOFException - if the value could not be read because no more data remains to be read
    
    IOException - if an I/O error occurs
  - readUnsignedShort
```
public int readUnsignedShort()
                      throws IOException
```
    Read an unsigned short value.
    This method is the counterpart for the DataOutput.writeShort(int) method when it is used with unsigned 16-bit values.
    
    Specified by:
    
    readUnsignedShort in interface ReadBuffer.BufferInput
    
    Specified by:
    
    readUnsignedShort in interface DataInput
    
    Returns:
    
    an int value in the range of 0x0000 to 0xFFFF
    
    Throws:
    
    EOFException - if the value could not be read because no more data remains to be read
    
    IOException - if an I/O error occurs
  - readChar
```
public char readChar()
              throws IOException
```
    Read a char value.
    This method is the counterpart for the DataOutput.writeChar(int) method.
    
    Specified by:
    
    readChar in interface ReadBuffer.BufferInput
    
    Specified by:
    
    readChar in interface DataInput
    
    Returns:
    
    a char value
    
    Throws:
    
    EOFException - if the value could not be read because no more data remains to be read
    
    IOException - if an I/O error occurs
  - readInt
```
public int readInt()
            throws IOException
```
    Read an int value.
    This method is the counterpart for the DataOutput.writeInt(int) method.
    
    Specified by:
    
    readInt in interface ReadBuffer.BufferInput
    
    Specified by:
    
    readInt in interface DataInput
    
    Returns:
    
    an int value
    
    Throws:
    
    EOFException - if the value could not be read because no more data remains to be read
    
    IOException - if an I/O error occurs
  - readLong
```
public long readLong()
              throws IOException
```
    Read a long value.
    This method is the counterpart for the DataOutput.writeLong(long) method.
    
    Specified by:
    
    readLong in interface ReadBuffer.BufferInput
    
    Specified by:
    
    readLong in interface DataInput
    
    Returns:
    
    a long value
    
    Throws:
    
    EOFException - if the value could not be read because no more data remains to be read
    
    IOException - if an I/O error occurs
  - readFloat
```
public float readFloat()
                throws IOException
```
    Read a float value.
    This method is the counterpart for the DataOutput.writeFloat(float) method.
    
    Specified by:
    
    readFloat in interface ReadBuffer.BufferInput
    
    Specified by:
    
    readFloat in interface DataInput
    
    Returns:
    
    a float value
    
    Throws:
    
    EOFException - if the value could not be read because no more data remains to be read
    
    IOException - if an I/O error occurs
  - readDouble
```
public double readDouble()
                  throws IOException
```
    Read a double value.
    This method is the counterpart for the DataOutput.writeDouble(double) method.
    
    Specified by:
    
    readDouble in interface ReadBuffer.BufferInput
    
    Specified by:
    
    readDouble in interface DataInput
    
    Returns:
    
    a double value
    
    Throws:
    
    EOFException - if the value could not be read because no more data remains to be read
    
    IOException - if an I/O error occurs
  - readLine
```
public String readLine()
                throws IOException
```
    Reads the next "line" of text.
    This method does not have a counterpart in the DataOutput interface. Furthermore, this method is defined as operating on bytes and not on characters, and thus it should be selected for use only after careful consideration, as if it were deprecated (which it has been in java.io.DataInputStream).
    
    Specified by:
    
    readLine in interface ReadBuffer.BufferInput
    
    Specified by:
    
    readLine in interface DataInput
    
    Returns:
    
    a line of text as a String
    
    Throws:
    
    IOException - if an I/O error occurs.
  - readUTF
```
public String readUTF()
               throws IOException
```
    Reads a String value.
    This method is the counterpart for the DataOutput.writeUTF(java.lang.String) method.
    
    Specified by:
    
    readUTF in interface ReadBuffer.BufferInput
    
    Specified by:
    
    readUTF in interface DataInput
    
    Returns:
    
    a String value
    
    Throws:
    
    UTFDataFormatException - if the bytes that were read were not a valid UTF-8 encoded string
    
    EOFException - if the value could not be read because no more data remains to be read
    
    IOException - if an I/O error occurs
  - getBuffer
```
public ReadBuffer getBuffer()
```
    Get the ReadBuffer object that this BufferInput is reading from.
    
    Specified by:
    
    getBuffer in interface ReadBuffer.BufferInput
    
    Returns:
    
    the underlying ReadBuffer object
  - readSafeUTF
```
public String readSafeUTF()
                   throws IOException
```
    Read a variable-length encoded UTF packed String. The major differences between this implementation and DataInput is that this supports null String values and is not limited to 64KB UTF-encoded values.
    
    Specified by:
    
    readSafeUTF in interface ReadBuffer.BufferInput
    
    Returns:
    
    a String value; may be null
    
    Throws:
    
    IOException - if an I/O error occurs
  - readPackedInt
```
public int readPackedInt()
                  throws IOException
```
    Read an int value using a variable-length storage format as described by WriteBuffer.BufferOutput.writePackedInt(int).
    
    Specified by:
    
    readPackedInt in interface ReadBuffer.BufferInput
    
    Returns:
    
    an int value
    
    Throws:
    
    IOException - if an I/O error occurs
  - readPackedLong
```
public long readPackedLong()
                    throws IOException
```
    Read a long value using a variable-length storage format as described by WriteBuffer.BufferOutput.writePackedLong(long).
    
    Specified by:
    
    readPackedLong in interface ReadBuffer.BufferInput
    
    Returns:
    
    a long value
    
    Throws:
    
    IOException - if an I/O error occurs
  - readBuffer
```
public ReadBuffer readBuffer(int cb)
                      throws IOException
```
    Read cb bytes and return them as a ReadBuffer object.
    
    Specified by:
    
    readBuffer in interface ReadBuffer.BufferInput
    
    Parameters:
    
    cb - the number of bytes to read
    
    Returns:
    
    a ReadBuffer object composed of cb bytes read from the BufferInput
    
    Throws:
    
    EOFException - if the stream is exhausted before the number of bytes indicated could be read
    
    IOException - if an I/O error occurs
  - getOffset
```
public int getOffset()
```
    Determine the current offset of this BufferInput within the underlying ReadBuffer.
    
    Specified by:
    
    getOffset in interface ReadBuffer.BufferInput
    
    Returns:
    
    the offset of the next byte to read from the ReadBuffer
  - setOffset
```
public void setOffset(int of)
```
    Specify the offset of the next byte to read from the underlying ReadBuffer.
    
    Specified by:
    
    setOffset in interface ReadBuffer.BufferInput
    
    Parameters:
    
    of - the offset of the next byte to read from the ReadBuffer
  - setOffsetInternal
```
protected void setOffsetInternal(int of)
```
    Update the internal stream offset.
    
    Parameters:
    
    of - the new offset
  - adjustOffsetInternal
```
protected void adjustOffsetInternal(int cb)
```
    Adjust the internal stream offset.
    
    Parameters:
    
    cb - the number of bytes that were written
  - getMarkInternal
```
protected int getMarkInternal()
```
    Obtain the offset of the stream mark.
    
    Returns:
    
    the offset of the mark or -1 if unmarked
  - setMarkInternal
```
protected void setMarkInternal(int of)
```
    Update the internal stream mark.
    
    Parameters:
    
    of - the offset of the new mark
  - getCharBuf
```
protected char[] getCharBuf(int cchMax)
```
    Obtain a temp buffer used to avoid allocations when building Strings from UTF binary data.
    
    Parameters:
    
    cchMax - the length that the String will not exceed
    
    Returns:
    
    a char buffer of at least the specified length
  - readUTF
```
protected String readUTF(int cb)
                  throws IOException
```
    Reads the specified-length UTF data and converts it to a String value.
    
    Parameters:
    
    cb - the number of bytes that the UTF data takes up in the stream; a value less than zero indicates a null value
    
    Returns:
    
    a String value; may be null if the passed length could be negative
    
    Throws:
    
    UTFDataFormatException - if the bytes that were read were not a valid UTF-8 encoded string
    
    EOFException - if the value could not be read because no more data remains to be read
    
    IOException - if an I/O error occurs
  - convertUTF
```
protected String convertUTF(int of,
                            int cb)
                     throws IOException
```
    Convert a UTF-8 encoded section of the binary stream into a String.
    
    Parameters:
    
    of - the offset within the stream
    
    cb - the length in bytes within the stream
    
    Returns:
    
    the String value
    
    Throws:
    
    IOException - if an I/O or conversion exception occurs, such as UTFDataFormatException

Class AbstractReadBuffer.AbstractBufferInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractBufferInput

Method Detail

read

read

read

skip

available

close

mark

reset

markSupported

readFully

readFully

skipBytes

readBoolean

readByte

readUnsignedByte

readShort

readUnsignedShort

readChar

readInt

readLong

readFloat

readDouble

readLine

readUTF

getBuffer

readSafeUTF

readPackedInt

readPackedLong

readBuffer

getOffset

setOffset

setOffsetInternal

adjustOffsetInternal

getMarkInternal

setMarkInternal

getCharBuf

readUTF

convertUTF