Класс DataInputStream

java.io.DataInputStream

Все реализованные интерфейсы:: Closeable, DataInput, AutoCloseable

public class DataInputStream extends FilterInputStream implements DataInput

Поток ввода данных позволяет приложению читать примитивные типы данных Java из базового потока ввода независимо от машины. Приложение использует поток вывода данных для записи данных, которые позже могут быть прочитаны потоком ввода данных.

Класс DataInputStream не предназначен для одновременного использования несколькими потоками. Если DataInputStream будет использоваться более чем одним потоком, доступ к потоку ввода данных должен контролироваться соответствующей синхронизацией.

С момента:

1.0

См. также:

Краткое описание полей

Поля, объявленные в классе java.io.FilterInputStream

in

Краткое описание конструкторов

Конструктор	Описание
`DataInputStream(InputStream in)`	Создаёт DataInputStream, использующий указанный базовый InputStream.

Краткое описание методов

Модификатор и тип	Метод	Описание
`final int`	`read(byte[] b)`	Читает некоторое количество байтов из содержащегося потока ввода и сохраняет их в массив буфера `b`.
`final int`	`read(byte[] b, int off, int len)`	Читает до `len` байтов данных из содержащегося потока ввода в массив байтов.
`final boolean`	`readBoolean()`	См. общее соглашение метода `readBoolean` класса `DataInput`.
`final byte`	`readByte()`	См. общее соглашение метода `readByte` класса `DataInput`.
`final char`	`readChar()`	См. общее соглашение метода `readChar` класса `DataInput`.
`final double`	`readDouble()`	См. общее соглашение метода `readDouble` класса `DataInput`.
`final float`	`readFloat()`	См. общее соглашение метода `readFloat` класса `DataInput`.
`final void`	`readFully(byte[] b)`	См. общее соглашение метода `readFully` класса `DataInput`.
`final void`	`readFully(byte[] b, int off, int len)`	См. общее соглашение метода `readFully` класса `DataInput`.
`final int`	`readInt()`	См. общее соглашение метода `readInt` класса `DataInput`.
`final String`	`readLine()`	Устарело. Этот метод не преобразует байты в символы должным образом.
`final long`	`readLong()`	См. общее соглашение метода `readLong` класса `DataInput`.
`final short`	`readShort()`	См. общее соглашение метода `readShort` класса `DataInput`.
`final int`	`readUnsignedByte()`	См. общее соглашение метода `readUnsignedByte` класса `DataInput`.
`final int`	`readUnsignedShort()`	См. общее соглашение метода `readUnsignedShort` класса `DataInput`.
`final String`	`readUTF()`	См. общее соглашение метода `readUTF` класса `DataInput`.
`static final String`	`readUTF(DataInput in)`	Читает из потока `in` представление строка символов Unicode, закодированных в формате изменённый UTF-8; эта строка символов возвращается как `String`.
`final int`	`skipBytes(int n)`	См. общее соглашение метода `skipBytes` класса `DataInput`.

Методы, объявленные в классе java.io.FilterInputStream

available, close, mark, markSupported, read, reset, skip

Методы, объявленные в классе java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание конструкторов

DataInputStream

public DataInputStream(InputStream in)

Создаёт DataInputStream, использующий указанный базовый InputStream.

Параметры:: in - указанный входной поток

Подробное описание методов

read

public final int read(byte[] b) throws IOException

Считывает некоторое количество байтов из содержащегося входного потока и записывает их в массив байтов b. Количество фактически прочитанных байтов возвращается в виде целого числа. Этот метод блокируется до тех пор, пока данные ввода не станут доступны, не будет обнаружен конец файла или не будет выброшено исключение.

Если b равно null, выбрасывается исключение NullPointerException. Если длина b равна нулю, то байты не считываются и возвращается значение 0; в противном случае выполняется попытка прочитать как минимум один байт. Если байт недоступен, потому что поток достиг конца файла, возвращается значение -1; в противном случае как минимум один байт считывается и записывается в b.

Первый прочитанный байт записывается в элемент b[0], следующий — в b[1] и так далее. Количество прочитанных байтов не превышает длины b. Пусть k — количество фактически прочитанных байтов; эти байты будут записаны в элементы с b[0] по b[k-1], оставляя элементы с b[k] по b[b.length-1] без изменений.

Метод read(b) имеет тот же эффект, что и:

 read(b, 0, b.length)

Переопределяет:

read в классе FilterInputStream

Параметры:

b - буфер, в который считываются данные.

Возвращает:

общее количество байтов, считанных в буфер, или -1, если больше нет данных из-за достижения конца потока.

Исключения:

IOException - если первый байт не может быть прочитан по какой-либо причине, кроме конца файла, поток был закрыт, и базовый входной поток не поддерживает чтение после закрытия, или произошла другая ошибка ввода-вывода.

См. также:

read

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

Считывает до len байтов данных из содержащегося входного потока в массив байтов. Предпринимается попытка прочитать до len байтов, но может быть прочитано меньшее количество байтов, возможно, ноль. Количество фактически прочитанных байтов возвращается в виде целого числа.

Этот метод блокируется до тех пор, пока данные ввода не станут доступны, не будет обнаружен конец файла или не будет выброшено исключение.

Если len равно нулю, то байты не считываются, и возвращается значение 0; в противном случае выполняется попытка прочитать как минимум один байт. Если байт недоступен, потому что поток достиг конца файла, возвращается значение -1; в противном случае как минимум один байт считывается и записывается в b.

Первый прочитанный байт записывается в элемент b[off], следующий — в b[off+1] и так далее. Количество прочитанных байтов не превышает len. Пусть k — количество фактически прочитанных байтов; эти байты будут записаны в элементы с b[off] по b[off+k-1], оставляя элементы с b[off+k] по b[off+len-1] без изменений.

Во всех случаях элементы b[0] по b[off] и элементы b[off+len] по b[b.length-1] остаются без изменений.

Переопределяет:

read в классе FilterInputStream

Параметры:

b - буфер, в который считываются данные.

off - начальный смещение в целевом массиве b

len - максимальное количество считываемых байтов.

Возвращает:

общее количество байтов, считанных в буфер, или -1, если больше нет данных из-за достижения конца потока.

Исключения:

NullPointerException - Если b равно null.

IndexOutOfBoundsException - Если off отрицательно, len отрицательно или len больше b.length - off

См. также:

readFully

public final void readFully(byte[] b) throws IOException

См. общий контракт метода readFully класса DataInput.

Байты для этой операции считываются из содержащегося входного потока.

Задано:

readFully в интерфейсе DataInput

Параметры:

b - буфер, в который считываются данные.

Исключения:

NullPointerException - если b равно null.

EOFException - если этот входной поток достигает конца до прочтения всех байтов.

IOException - поток был закрыт, и содержащийся входной поток не поддерживает чтение после закрытия, или произошла другая ошибка ввода-вывода.

См. также:

readFully

public final void readFully(byte[] b, int off, int len) throws IOException

См. общий контракт метода readFully класса DataInput.

Байты для этой операции считываются из содержащегося входного потока.

Задано:

readFully в интерфейсе DataInput

Параметры:

b - буфер, в который считываются данные.

off - начальный смещение в массиве данных b.

len - количество байтов для чтения.

Исключения:

NullPointerException - если b равно null.

IndexOutOfBoundsException - если off отрицательно, len отрицательно или len больше b.length - off.

EOFException - если этот входной поток достигает конца до прочтения всех байтов.

См. также:

skipBytes

public final int skipBytes(int n) throws IOException

См. общий контракт метода skipBytes класса DataInput.

Байты для этой операции считываются из содержащегося входного потока.

Задано:: skipBytes в интерфейсе DataInput
Параметры:: n - количество байтов, которые необходимо пропустить.
Возвращает:: фактическое количество пропущенных байтов.
Исключения:: IOException - если содержащийся входной поток не поддерживает перемещение, или поток был закрыт, и содержащийся входной поток не поддерживает чтение после закрытия, или произошла другая ошибка ввода-вывода.

readBoolean

public final boolean readBoolean() throws IOException

См. общий контракт метода readBoolean класса DataInput.

Байты для этой операции считываются из содержащегося входного потока.

Задано:

readBoolean в интерфейсе DataInput

Возвращает:

прочитанное значение boolean.

Исключения:

EOFException - если этот входной поток достиг конца.

См. также:

readByte

public final byte readByte() throws IOException

См. общий контракт метода readByte класса DataInput.

Байты для этой операции считываются из содержащегося входного потока.

Задано:

readByte в интерфейсе DataInput

Возвращает:

следующий байт этого входного потока как знаковое 8-битное byte.

Исключения:

EOFException - если этот входной поток достиг конца.

См. также:

readUnsignedByte

public final int readUnsignedByte() throws IOException

См. общий контракт метода readUnsignedByte класса DataInput.

Байты для этой операции считываются из содержащегося потока ввода.

Определено в:

readUnsignedByte в интерфейсе DataInput

Возвращает:

следующий байт этого потока ввода, интерпретированный как целое без знака 8-битное число.

Исключение:

EOFException - если этот поток ввода достиг конца.

IOException - поток закрыт, и содержащийся поток ввода не поддерживает чтение после закрытия, или произошла другая ошибка ввода-вывода.

См. также:

readShort

public final short readShort() throws IOException

См. общий контракт метода readShort класса DataInput.

Байты для этой операции считываются из содержащегося потока ввода.

Определено в:

readShort в интерфейсе DataInput

Возвращает:

два следующих байта этого потока ввода, интерпретированные как целое со знаком 16-битное число.

Исключение:

EOFException - если этот поток ввода достигает конца, прежде чем считать два байта.

См. также:

readUnsignedShort

public final int readUnsignedShort() throws IOException

См. общий контракт метода readUnsignedShort класса DataInput.

Байты для этой операции считываются из содержащегося потока ввода.

Определено в:

readUnsignedShort в интерфейсе DataInput

Возвращает:

два следующих байта этого потока ввода, интерпретированные как целое без знака 16-битное число.

Исключение:

EOFException - если этот поток ввода достигает конца, прежде чем считать два байта.

См. также:

readChar

public final char readChar() throws IOException

См. общий контракт метода readChar класса DataInput.

Байты для этой операции считываются из содержащегося потока ввода.

Определено в:

readChar в интерфейсе DataInput

Возвращает:

два следующих байта этого потока ввода, интерпретированные как символ.

Исключение:

EOFException - если этот поток ввода достигает конца, прежде чем считать два байта.

См. также:

readInt

public final int readInt() throws IOException

См. общий контракт метода readInt класса DataInput.

Байты для этой операции считываются из содержащегося потока ввода.

Определено в:

readInt в интерфейсе DataInput

Возвращает:

четыре следующих байта этого потока ввода, интерпретированные как целое.

Исключение:

EOFException - если этот поток ввода достигает конца, прежде чем считать четыре байта.

См. также:

readLong

public final long readLong() throws IOException

См. общий контракт метода readLong класса DataInput.

Байты для этой операции считываются из содержащегося потока ввода.

Определено в:

readLong в интерфейсе DataInput

Возвращает:

восемь следующих байтов этого потока ввода, интерпретированные как длинное целое.

Исключение:

EOFException - если этот поток ввода достигает конца, прежде чем считать восемь байтов.

См. также:

readFloat

public final float readFloat() throws IOException

См. общий контракт метода readFloat класса DataInput.

Байты для этой операции считываются из содержащегося потока ввода.

Определено в:

readFloat в интерфейсе DataInput

Возвращает:

четыре следующих байта этого потока ввода, интерпретированные как число с плавающей точкой.

Исключение:

EOFException - если этот поток ввода достигает конца, прежде чем считать четыре байта.

См. также:

readDouble

public final double readDouble() throws IOException

См. общий контракт метода readDouble класса DataInput.

Байты для этой операции считываются из содержащегося потока ввода.

Определено в:

readDouble в интерфейсе DataInput

Возвращает:

восемь следующих байтов этого потока ввода, интерпретированные как число с двойной точностью.

Исключение:

EOFException - если этот поток ввода достигает конца, прежде чем считать восемь байтов.

См. также:

readLine

@Deprecated public final String readLine() throws IOException

Устарело.

Этот метод не правильно преобразует байты в символы. Начиная с JDK 1.1, предпочтительным способом чтения строк текста является метод BufferedReader.readLine(). Программы, использующие класс DataInputStream для чтения строк, можно преобразовать для использования класса BufferedReader, заменив код в формате:

     DataInputStream d = new DataInputStream(in);

на:

     BufferedReader d
          = new BufferedReader(new InputStreamReader(in));

См. общий контракт метода readLine класса DataInput.

Байты для этой операции считываются из содержащегося потока ввода.

Определено в:

readLine в интерфейсе DataInput

Возвращает:

следующую строку текста из этого потока ввода.

Исключение:

IOException - если произошла ошибка ввода-вывода.

См. также:

readUTF

public final String readUTF() throws IOException

См. общий контракт метода readUTF класса DataInput.

Байты для этой операции считываются из содержащегося потока ввода.

Определено в:

readUTF в интерфейсе DataInput

Возвращает:

строку Unicode.

Исключение:

EOFException - если этот поток ввода достигает конца, прежде чем считать все байты.

UTFDataFormatException - если байты не представляют собой допустимое кодирование строки UTF-8.

См. также:

readUTF

public static final String readUTF(DataInput in) throws IOException

Считывает из потока in представление строки символов Unicode, закодированной в формате изменённом UTF-8; эта строка символов возвращается как строка.

Параметры:

in - поток ввода данных.

Возвращает:

строку Unicode.

Исключение:

EOFException - если поток ввода достигает конца, прежде чем все байты будут считаны.

UTFDataFormatException - если байты не представляют собой допустимое кодирование строки Unicode в изменённом UTF-8.

См. также:

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://download.java.net/java/early_access/jdk24/docs/api/java.base/java/io/DataInputStream.html