Spec-Zone.ru › OpenJDK 25

Класс DataInputStream

java.lang.Object
java.io.InputStream
java.io.FilterInputStream
java.io.DataInputStream
Все реализуемые интерфейсы:
Closeable, DataInput, AutoCloseable
public class DataInputStream extends FilterInputStream implements DataInput
Поток ввода данных позволяет приложению независимым от машины способом считывать примитивные типы данных Java из базового входного потока. Приложение использует поток вывода данных для записи данных, которые впоследствии можно прочитать с помощью потока ввода данных.

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

С версии:
1.0
См. также:
  • DataOutputStream

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

Поля, объявленные в классе 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.

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

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

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

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Методы, объявленные в классе 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 — если первый байт не удается считать по любой причине, кроме достижения конца файла, поток закрыт и базовый входной поток не поддерживает чтение после закрытия или возникает другая ошибка ввода-вывода.
См. также:
  • FilterInputStream.in
  • InputStream.read(byte[], int, int)

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
IOException — если первый байт не удается считать по любой причине, кроме достижения конца файла, поток закрыт и базовый входной поток не поддерживает чтение после закрытия или возникает другая ошибка ввода-вывода.
См. также:
  • FilterInputStream.in
  • InputStream.read(byte[], int, int)

readFully

public final void readFully(byte[] b) throws IOException
См. общий контракт метода readFully интерфейса DataInput.

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

Определено в:
readFully в интерфейсе DataInput
Параметры:
b — буфер, в который считываются данные.
Выбрасывает:
NullPointerException — если b равно null.
EOFException — если этот входной поток достигает конца до считывания всех байтов.
IOException — если поток закрыт и содержащийся входной поток не поддерживает чтение после закрытия или возникает другая ошибка ввода-вывода.
См. также:
  • FilterInputStream.in

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 — если этот входной поток достигает конца до считывания всех байтов.
IOException — если поток закрыт и содержащийся входной поток не поддерживает чтение после закрытия или возникает другая ошибка ввода-вывода.
См. также:
  • FilterInputStream.in

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 — если этот входной поток достиг конца.
IOException — если поток закрыт и содержащийся входной поток не поддерживает чтение после закрытия или возникает другая ошибка ввода-вывода.
См. также:
  • FilterInputStream.in

readByte

public final byte readByte() throws IOException
См. общий контракт метода readByte интерфейса DataInput.

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

Определено в:
readByte в интерфейсе DataInput
Возвращает:
следующий байт этого входного потока как знаковое 8-битное значение byte.
Выбрасывает:
EOFException — если этот входной поток достиг конца.
IOException — если поток закрыт и содержащийся входной поток не поддерживает чтение после закрытия или возникает другая ошибка ввода-вывода.
См. также:
  • FilterInputStream.in

readUnsignedByte

public final int readUnsignedByte() throws IOException
См. общий контракт метода readUnsignedByte интерфейса DataInput.

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

Определено в:
readUnsignedByte в интерфейсе DataInput
Возвращает:
следующий байт этого входного потока, интерпретируемый как беззнаковое 8-битное число.
Выбрасывает:
EOFException — если этот входной поток достиг конца.
IOException — если поток закрыт и содержащийся входной поток не поддерживает чтение после закрытия или возникает другая ошибка ввода-вывода.
См. также:
  • FilterInputStream.in

readShort

public final short readShort() throws IOException
См. общий контракт метода readShort интерфейса DataInput.

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

Определено в:
readShort в интерфейсе DataInput
Возвращает:
следующие два байта этого входного потока, интерпретируемые как знаковое 16-битное число.
Выбрасывает:
EOFException — если этот входной поток достигает конца до считывания двух байтов.
IOException — если поток закрыт и содержащийся входной поток не поддерживает чтение после закрытия или возникает другая ошибка ввода-вывода.
См. также:
  • FilterInputStream.in

readUnsignedShort

public final int readUnsignedShort() throws IOException
См. общий контракт метода readUnsignedShort интерфейса DataInput.

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

Определено в:
readUnsignedShort в интерфейсе DataInput
Возвращает:
следующие два байта этого входного потока, интерпретируемые как беззнаковое 16-битное целое число.
Выбрасывает:
EOFException — если этот входной поток достигает конца до считывания двух байтов.
IOException — если поток закрыт и содержащийся входной поток не поддерживает чтение после закрытия или возникает другая ошибка ввода-вывода.
См. также:
  • FilterInputStream.in

readChar

public final char readChar() throws IOException
См. общий контракт метода readChar интерфейса DataInput.

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

Определено в:
readChar в интерфейсе DataInput
Возвращает:
следующие два байта этого входного потока, интерпретируемые как char.
Выбрасывает:
EOFException — если этот входной поток достигает конца до считывания двух байтов.
IOException — если поток закрыт и содержащийся входной поток не поддерживает чтение после закрытия или возникает другая ошибка ввода-вывода.
См. также:
  • FilterInputStream.in

readInt

public final int readInt() throws IOException
См. общий контракт метода readInt интерфейса DataInput.

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

Определено в:
readInt в интерфейсе DataInput
Возвращает:
следующие четыре байта этого входного потока, интерпретируемые как int.
Выбрасывает:
EOFException — если этот входной поток достигает конца до считывания четырех байтов.
IOException — если поток закрыт и содержащийся входной поток не поддерживает чтение после закрытия или возникает другая ошибка ввода-вывода.
См. также:
  • FilterInputStream.in

readLong

public final long readLong() throws IOException
См. общий контракт метода readLong интерфейса DataInput.

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

Определено в:
readLong в интерфейсе DataInput
Возвращает:
следующие восемь байтов этого входного потока, интерпретируемые как long.
Выбрасывает:
EOFException — если этот входной поток достигает конца до считывания восьми байтов.
IOException — если поток закрыт и содержащийся входной поток не поддерживает чтение после закрытия или возникает другая ошибка ввода-вывода.
См. также:
  • FilterInputStream.in

readFloat

public final float readFloat() throws IOException
См. общий контракт метода readFloat интерфейса DataInput.

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

Определено в:
readFloat в интерфейсе DataInput
Возвращает:
следующие четыре байта этого входного потока, интерпретируемые как float.
Выбрасывает:
EOFException — если этот входной поток достигает конца до считывания четырех байтов.
IOException — если поток закрыт и содержащийся входной поток не поддерживает чтение после закрытия или возникает другая ошибка ввода-вывода.
См. также:
  • readInt()
  • Float.intBitsToFloat(int)

readDouble

public final double readDouble() throws IOException
См. общий контракт метода readDouble интерфейса DataInput.

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

Определено в:
readDouble в интерфейсе DataInput
Возвращает:
следующие восемь байтов этого входного потока, интерпретируемые как double.
Выбрасывает:
EOFException — если этот входной поток достигает конца до считывания восьми байтов.
IOException — если поток закрыт и содержащийся входной поток не поддерживает чтение после закрытия или возникает другая ошибка ввода-вывода.
См. также:
  • readLong()
  • Double.longBitsToDouble(long)

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 — если возникает ошибка ввода-вывода.
См. также:
  • BufferedReader.readLine()
  • FilterInputStream.in

readUTF

public final String readUTF() throws IOException
См. общий контракт метода readUTF интерфейса DataInput.

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

Определено в:
readUTF в интерфейсе DataInput
Возвращает:
строку Unicode.
Выбрасывает:
EOFException — если этот входной поток достигает конца до считывания всех байтов.
IOException — если поток закрыт и содержащийся входной поток не поддерживает чтение после закрытия или возникает другая ошибка ввода-вывода.
UTFDataFormatException — если байты не представляют допустимую строку в кодировке модифицированной UTF-8.
См. также:
  • readUTF(java.io.DataInput)

readUTF

public static final String readUTF(DataInput in) throws IOException
Считывает из потока in представление строки символов Unicode в формате модифицированной UTF-8; эта строка символов возвращается как String. Подробности представления в модифицированной UTF-8 полностью совпадают с описанием метода readUTF интерфейса DataInput.
Параметры:
in — поток ввода данных.
Возвращает:
строку Unicode.
Выбрасывает:
EOFException — если входной поток достигает конца до считывания всех байтов.
IOException — если поток закрыт и содержащийся входной поток не поддерживает чтение после закрытия или возникает другая ошибка ввода-вывода.
UTFDataFormatException — если байты не представляют допустимую строку Unicode в кодировке модифицированной UTF-8.
См. также:
  • readUnsignedShort()

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, включая концептуальные обзоры, определения терминов, обходные решения и работающие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторские права © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/io/DataInputStream.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API