Package java.io

Class DataInputStream

    • Constructor Detail

      • DataInputStream

        public DataInputStream​(InputStream in)
        Constructs a new DataInputStream on the InputStream in. All reads are then filtered through this stream. Note that data read by this stream is not in a human readable format and was most likely created by a DataOutputStream.

        Warning: passing a null source creates an invalid DataInputStream. All operations on such a stream will fail.

        Parameters:
        in - the source InputStream the filter reads from.
        See Also:
        DataOutputStream, RandomAccessFile
    • Method Detail

      • read

        public final int read​(byte[] buffer,
                              int byteOffset,
                              int byteCount)
                       throws IOException
        Description copied from class: InputStream
        Reads up to byteCount bytes from this stream and stores them in the byte array buffer starting at byteOffset. Returns the number of bytes actually read or -1 if the end of the stream has been reached.
        Overrides:
        read in class FilterInputStream
        Throws:
        IOException - if the stream is closed or another IOException occurs.
      • readFully

        public final void readFully​(byte[] dst,
                                    int offset,
                                    int byteCount)
                             throws IOException
        Description copied from interface: DataInput
        Reads byteCount bytes from this stream and stores them in the byte array dst starting at offset. If byteCount is zero, then this method returns without reading any bytes. Otherwise, this method blocks until byteCount bytes have been read. If insufficient bytes are available, EOFException is thrown. If an I/O error occurs, IOException is thrown. When an exception is thrown, some bytes may have been consumed from the stream and written into the array.
        Specified by:
        readFully in interface DataInput
        Parameters:
        dst - the byte array into which the data is read.
        offset - the offset in dst at which to store the bytes.
        byteCount - the number of bytes to read.
        Throws:
        EOFException - if the end of the source stream is reached before enough bytes have been read.
        IOException - if a problem occurs while reading from this stream.
      • readLine

        @Deprecated
        public final String readLine()
                              throws IOException
        Deprecated.
        This method cannot be trusted to convert bytes to characters correctly. Wrap this stream with a BufferedReader instead.
        Description copied from interface: DataInput
        Returns a string containing the next line of text available from this stream. A line is made of zero or more characters followed by '\n', '\r', "\r\n" or the end of the stream. The string does not include the newline sequence.
        Specified by:
        readLine in interface DataInput
        Returns:
        the contents of the line or null if no characters have been read before the end of the stream.
        Throws:
        EOFException - if the end of the input is reached before the read request can be satisfied.
        IOException - if an I/O error occurs while reading.
      • readUnsignedByte

        public final int readUnsignedByte()
                                   throws IOException
        Description copied from interface: DataInput
        Reads an unsigned 8-bit byte value and returns it as an int.
        Specified by:
        readUnsignedByte in interface DataInput
        Returns:
        the next unsigned byte value.
        Throws:
        EOFException - if the end of the input is reached before the read request can be satisfied.
        IOException - if an I/O error occurs while reading.
        See Also:
        DataOutput.writeByte(int)
      • readUnsignedShort

        public final int readUnsignedShort()
                                    throws IOException
        Description copied from interface: DataInput
        Reads a big-endian 16-bit unsigned short value and returns it as an int.
        Specified by:
        readUnsignedShort in interface DataInput
        Returns:
        the next unsigned short value.
        Throws:
        EOFException - if the end of the input is reached before the read request can be satisfied.
        IOException - if an I/O error occurs while reading.
        See Also:
        DataOutput.writeShort(int)
      • skipBytes

        public final int skipBytes​(int count)
                            throws IOException
        Skips count number of bytes in this stream. Subsequent read()s will not return these bytes unless reset() is used. This method will not throw an EOFException if the end of the input is reached before count bytes where skipped.
        Specified by:
        skipBytes in interface DataInput
        Parameters:
        count - the number of bytes to skip.
        Returns:
        the number of bytes actually skipped.
        Throws:
        IOException - if a problem occurs during skipping.
        See Also:
        FilterInputStream.mark(int), FilterInputStream.reset()