Package com.tangosol.io

Class AbstractReadBuffer.AbstractBufferInput

    • Constructor Detail

      • AbstractBufferInput

        public AbstractBufferInput()
        Default constructor.
        Implementation Requirements:
        Initialize serial filter as it done for ObjectInputStream constructor.

        In Java versions prior to 17, the deserialization filter is initialized to JVM-wide ObjectInputFilter.

        In Java version 17 and greater, the deserialization filter is initialized to the filter returned by invoking serial filter factory with null for the current filter and the static JVM-wide filter for the requested filter.

    • 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 AutoCloseable
        Specified by:
        close in interface Closeable
        Specified by:
        close in interface com.oracle.coherence.common.io.InputStreaming
        Specified by:
        close in interface ReadBuffer.BufferInput
        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

      • 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 DataInput
        Specified by:
        readFully in interface ReadBuffer.BufferInput
        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 DataInput
        Specified by:
        readFully in interface ReadBuffer.BufferInput
        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 DataInput
        Specified by:
        skipBytes in interface ReadBuffer.BufferInput
        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

      • 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 DataInput
        Specified by:
        readLine in interface ReadBuffer.BufferInput
        Returns:
        a line of text as a String
        Throws:
        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

      • 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

      • getObjectInputFilter

        public final Object getObjectInputFilter()
        Description copied from interface: ReadBuffer.BufferInput
        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.

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

      • setObjectInputFilter

        public final void setObjectInputFilter​(Object oInputFilter)
        Description copied from interface: ReadBuffer.BufferInput
        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.

        Specified by:
        setObjectInputFilter in interface ReadBuffer.BufferInput
        Parameters:
        oInputFilter - an ObjectInputFilter instance as an Object to enable running with Java version 8 or higher, may be null

      • 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