Package com.tangosol.io

Interface ReadBuffer.BufferInput

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      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.
      ReadBuffer getBuffer()
      Get the ReadBuffer object that this BufferInput is reading from.
      default Object getObjectInputFilter()
      Returns an ObjectInputFilter (or null) that should be used by the caller to confirm / deny deserialization of a class encoded in this input stream.
      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 mark(int) and InputStreaming.reset() methods.
      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.
      default void setObjectInputFilter​(Object oInputFilter)
      Set the ObjectInputFilter for this stream.
      void setOffset​(int of)
      Specify the offset of the next byte to read from the underlying ReadBuffer.
      int skipBytes​(int cb)
      Skips over up to the specified number of bytes of data.

      • Methods inherited from interface com.oracle.coherence.common.io.InputStreaming

        read, read, read, reset, skip

    • Method Detail

      • available

        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
        Returns:
        the number of bytes that can be read from this InputStream without blocking
        Throws:
        IOException - if an I/O error occurs

      • close

        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
        Throws:
        IOException - if an I/O error occurs

      • mark

        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
        Parameters:
        cbReadLimit - the maximum number of bytes that caller expects the InputStream to be able to read before the mark position becomes invalid

      • markSupported

        boolean markSupported()
        Determine if this InputStream supports the mark(int) and InputStreaming.reset() methods.

        BufferInput implementations must support the mark(int) and InputStreaming.reset() methods, so this method always returns true.

        Specified by:
        markSupported in interface com.oracle.coherence.common.io.InputStreaming
        Returns:
        true if this InputStream supports the mark and reset method; false otherwise

      • readFully

        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 DataInput
        Parameters:
        ab - the array to store the bytes which are read from the stream
        Throws:
        NullPointerException - if the passed array is null
        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

        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 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:
        NullPointerException - if the passed array is null
        IndexOutOfBoundsException - if of or cb is negative, or of+cb is greater than the length of the ab
        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

        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 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

      • readUnsignedByte

        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 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

      • readUnsignedShort

        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 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

      • readLine

        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 DataInput
        Returns:
        a line of text as a String
        Throws:
        IOException - if an I/O error occurs.

      • getBuffer

        ReadBuffer getBuffer()
        Get the ReadBuffer object that this BufferInput is reading from.
        Returns:
        the underlying ReadBuffer object

      • readSafeUTF

        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.
        Returns:
        a String value; may be null
        Throws:
        IOException - if an I/O error occurs

      • readBuffer

        ReadBuffer readBuffer​(int cb)
               throws IOException
        Read cb bytes and return them as a ReadBuffer object.
        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

        int getOffset()
        Determine the current offset of this BufferInput within the underlying ReadBuffer.
        Returns:
        the offset of the next byte to read from the ReadBuffer

      • setOffset

        void setOffset​(int of)
        Specify the offset of the next byte to read from the underlying ReadBuffer.
        Parameters:
        of - the offset of the next byte to read from the ReadBuffer
        Throws:
        IndexOutOfBoundsException - if of < 0 or of > getBuffer().length()

      • getObjectInputFilter

        default Object getObjectInputFilter()
        Returns an ObjectInputFilter (or null) that should be used by the caller to confirm / deny deserialization of a class encoded in this input stream.

        Note: the return type is agnostic of the ObjectInputFilter to support various JDK versions.

        Returns:
        null or an ObjectInputFilter that will permit (or not) the constructor of a class encoded in this stream.
        See Also:
        setObjectInputFilter(Object)

      • setObjectInputFilter

        default void setObjectInputFilter​(Object oInputFilter)
        Set the ObjectInputFilter for this stream.

        The filter's checkInput method is expected to be called for each class and reference deserialized in the stream.

        Parameters:
        oInputFilter - an ObjectInputFilter instance as an Object to enable running with Java version 8 or higher, may be null
        Throws:
        IllegalStateException - if the filter factory returns null when the current filter is non-null, or if the filter has already been set.
        Implementation Requirements:
        This method can set the ObjectInputFilter once.

        In Java version 17 and greater, the stream's ObjectInputFilter is set to the filter returned by invoking the JVM-wide filter factory with the getObjectInputFilter() current filter} and thefilter parameter.

        It is not permitted to replace a non-null filter with a null filter. If the current filter is non-null, the value returned from the filter factory (or provided filter) must be non-null.