Класс FileImageInputStream

java.lang.Object

javax.imageio.stream.ImageInputStreamImpl

javax.imageio.stream.FileImageInputStream

Все реализуемые интерфейсы:: Closeable, DataInput, AutoCloseable, ImageInputStream

public class FileImageInputStream extends ImageInputStreamImpl

Реализация ImageInputStream, получающая входные данные из File или RandomAccessFile. Предполагается, что содержимое файла остается неизменным в течение срока существования объекта.

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

Поля, объявленные в классе ImageInputStreamImpl

bitOffset, byteOrder, flushedPos, streamPos

Модификатор и тип	Поле	Описание
`protected int`	`bitOffset`	Текущее смещение бита в потоке.
`protected ByteOrder`	`byteOrder`	Порядок байтов потока в виде экземпляра класса перечисления `java.nio.ByteOrder`, где `ByteOrder.BIG_ENDIAN` обозначает сетевой порядок байтов, а `ByteOrder.LITTLE_ENDIAN` — обратный порядок.
`protected long`	`flushedPos`	Позиция, предшествующие которой данные могут быть отброшены.
`protected long`	`streamPos`	Текущая позиция чтения в потоке.

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

Конструктор	Описание
`FileImageInputStream(File f)`	Создает `FileImageInputStream`, который будет считывать данные из заданного `File`.
`FileImageInputStream(RandomAccessFile raf)`	Создает `FileImageInputStream`, который будет считывать данные из заданного `RandomAccessFile`.

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

Модификатор и тип	Метод	Описание
`long`	`length()`	Возвращает длину базового файла или `-1`, если она неизвестна.
`int`	`read()`	Считывает из потока один байт и возвращает его как `int` в диапазоне от 0 до 255.
`int`	`read(byte[] b, int off, int len)`	Считывает из потока до `len` байт и сохраняет их в `b`, начиная с индекса `off`.

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

checkClosed, close, flush, flushBefore, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, isCached, isCachedFile, isCachedMemory, mark, read, readBit, readBits, readBoolean, readByte, readBytes, readChar, readDouble, readFloat, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTF, reset, seek, setBitOffset, setByteOrder, skipBytes, skipBytes

Модификатор и тип	Метод	Описание
`protected final void`	`checkClosed()`	Выбрасывает `IOException`, если поток закрыт.
`void`	`close()`	Закрывает поток.
`void`	`flush()`	Отбрасывает начальную позицию потока до текущей позиции в потоке.
`void`	`flushBefore(long pos)`	Отбрасывает начальную часть потока до указанной позиции.
`int`	`getBitOffset()`	Возвращает текущее смещение бита в виде целого числа в диапазоне от 0 до 7 включительно.
`ByteOrder`	`getByteOrder()`	Возвращает порядок байтов, в соответствии с которым значения данных будут считываться из этого потока, в виде экземпляра перечисления `java.nio.ByteOrder`.
`long`	`getFlushedPosition()`	Возвращает самую раннюю позицию в потоке, на которую можно перейти.
`long`	`getStreamPosition()`	Возвращает текущую позицию байта в потоке.
`boolean`	`isCached()`	Реализация по умолчанию возвращает false.
`boolean`	`isCachedFile()`	Реализация по умолчанию возвращает false.
`boolean`	`isCachedMemory()`	Реализация по умолчанию возвращает false.
`void`	`mark()`	Помещает текущую позицию потока в стек отмеченных позиций.
`int`	`read(byte[] b)`	Вспомогательный метод, вызывающий `read(b, 0, b.length)`.
`int`	`readBit()`	Считывает из потока один бит и возвращает его как `int` со значением `0` или `1`.
`long`	`readBits(int numBits)`	Считывает битовую строку из потока и возвращает ее как `long`; первый считанный бит становится старшим битом результата.
`boolean`	`readBoolean()`	Считывает байт из потока и возвращает значение `boolean`: `true`, если оно ненулевое, и `false`, если оно равно нулю.
`byte`	`readByte()`	Считывает байт из потока и возвращает его как значение `byte`.
`void`	`readBytes(IIOByteBuffer buf, int len)`	Считывает из потока до `len` байт и изменяет переданный `IIOByteBuffer`, указывая массив байтов, смещение и длину, по которым можно найти данные.
`char`	`readChar()`	Эквивалентен `readUnsignedShort`, за исключением того, что результат возвращается с использованием типа данных `char`.
`double`	`readDouble()`	Считывает из потока 8 байт, концептуально объединяет их в соответствии с текущим порядком байтов и возвращает результат как `double`.
`float`	`readFloat()`	Считывает из потока 4 байта, концептуально объединяет их в соответствии с текущим порядком байтов и возвращает результат как `float`.
`void`	`readFully(byte[] b)`	Считывает из потока `b.length` байт и сохраняет их в `b`, начиная с индекса `0`.
`void`	`readFully(byte[] b, int off, int len)`	Считывает из потока `len` байт и сохраняет их в `b`, начиная с индекса `off`.
`void`	`readFully(char[] c, int off, int len)`	Считывает `len` символов (беззнаковых 16-разрядных целых чисел) из потока в соответствии с текущим порядком байтов и сохраняет их в `c`, начиная с индекса `off`.
`void`	`readFully(double[] d, int off, int len)`	Считывает `len` чисел типа double (64-разрядных чисел с плавающей запятой двойной точности по IEEE) из потока в соответствии с текущим порядком байтов и сохраняет их в `d`, начиная с индекса `off`.
`void`	`readFully(float[] f, int off, int len)`	Считывает `len` чисел типа float (32-разрядных чисел с плавающей запятой одинарной точности по IEEE) из потока в соответствии с текущим порядком байтов и сохраняет их в `f`, начиная с индекса `off`.
`void`	`readFully(int[] i, int off, int len)`	Считывает `len` чисел типа int (знаковых 32-разрядных целых чисел) из потока в соответствии с текущим порядком байтов и сохраняет их в `i`, начиная с индекса `off`.
`void`	`readFully(long[] l, int off, int len)`	Считывает `len` чисел типа long (знаковых 64-разрядных целых чисел) из потока в соответствии с текущим порядком байтов и сохраняет их в `l`, начиная с индекса `off`.
`void`	`readFully(short[] s, int off, int len)`	Считывает `len` чисел типа short (знаковых 16-разрядных целых чисел) из потока в соответствии с текущим порядком байтов и сохраняет их в `s`, начиная с индекса `off`.
`int`	`readInt()`	Считывает из потока 4 байта, концептуально объединяет их в соответствии с текущим порядком байтов и возвращает результат как `int`.
`String`	`readLine()`	Считывает следующую строку текста из входного потока.
`long`	`readLong()`	Считывает из потока 8 байт, концептуально объединяет их в соответствии с текущим порядком байтов и возвращает результат как `long`.
`short`	`readShort()`	Считывает из потока два байта, концептуально объединяет их в соответствии с текущим порядком байтов и возвращает результат как значение `short`.
`int`	`readUnsignedByte()`	Считывает байт из потока, концептуально преобразует его в int, применяет к нему маску `0xff` для удаления битов расширения знака и возвращает его как значение `byte`.
`long`	`readUnsignedInt()`	Считывает из потока 4 байта, концептуально объединяет их в соответствии с текущим порядком байтов, преобразует результат в long, применяет к нему маску `0xffffffffL` для удаления битов расширения знака и возвращает результат как беззнаковое значение `long`.
`int`	`readUnsignedShort()`	Считывает из потока два байта, концептуально объединяет их в соответствии с текущим порядком байтов, преобразует полученное значение в `int`, применяет к нему маску `0xffff` для удаления битов расширения знака и возвращает результат как беззнаковое значение `int`.
`String`	`readUTF()`	Считывает строку, закодированную в формате модифицированного UTF-8.
`void`	`reset()`	Восстанавливает текущие позиции байта и бита в потоке из стека отмеченных позиций.
`void`	`seek(long pos)`	Устанавливает текущую позицию потока в заданное место.
`void`	`setBitOffset(int bitOffset)`	Устанавливает смещение бита в целое число от 0 до 7 включительно.
`void`	`setByteOrder(ByteOrder byteOrder)`	Задает порядок байтов, который будет использоваться при дальнейшем чтении значений данных из этого потока.
`int`	`skipBytes(int n)`	Сдвигает текущую позицию потока, вызывая `seek(getStreamPosition() + n)`.
`long`	`skipBytes(long n)`	Сдвигает текущую позицию потока, вызывая `seek(getStreamPosition() + n)`.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект некоторому другому объекту.
`protected void`	`finalize()`	Устарело, подлежит удалению: этот элемент API может быть удален в будущей версии. Финализация устарела и подлежит удалению в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно вследствие вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно вследствие вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно вследствие вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

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

FileImageInputStream

public FileImageInputStream(File f) throws FileNotFoundException, IOException

Создает FileImageInputStream, который будет считывать данные из заданного File.

Содержимое файла не должно изменяться с момента создания этого объекта до последнего вызова метода чтения.

Параметры:: f — File, из которого следует считывать данные.
Исключения:: IllegalArgumentException — если f равно null.; FileNotFoundException — если f является каталогом или по любой другой причине не может быть открыт для чтения.; IOException — если произошла ошибка ввода-вывода.

FileImageInputStream

public FileImageInputStream(RandomAccessFile raf)

Создает FileImageInputStream, который будет считывать данные из заданного RandomAccessFile.

Содержимое файла не должно изменяться с момента создания этого объекта до последнего вызова метода чтения.

Параметры:: raf — RandomAccessFile, из которого следует считывать данные.
Исключения:: IllegalArgumentException — если raf равно null.

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

read

public int read() throws IOException

Описание скопировано из класса: ImageInputStreamImpl

Считывает из потока один байт и возвращает его как int в диапазоне от 0 до 255. Если достигнут конец файла, возвращается -1.

Подклассы должны предоставить реализацию этого метода. Реализация в подклассе должна обновить позицию потока перед завершением работы.

Перед чтением смещение бита в потоке должно быть сброшено в ноль.

Определено в:: read в интерфейсе ImageInputStream
Определено в:: read в классе ImageInputStreamImpl
Возвращает:: значение следующего байта в потоке или -1, если достигнут конец файла.
Исключения:: IOException — если поток закрыт.

read

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

Описание скопировано из класса: ImageInputStreamImpl

Считывает из потока до len байт и сохраняет их в b, начиная с индекса off. Если из-за достижения конца потока не удалось считать ни одного байта, возвращается -1.

Перед чтением смещение бита в потоке должно быть сброшено в ноль.

Определено в:: read в интерфейсе ImageInputStream
Определено в:: read в классе ImageInputStreamImpl
Параметры:: b — массив байтов для записи.; off — начальная позиция в b, начиная с которой следует выполнять запись.; len — максимальное количество байтов для чтения.
Возвращает:: фактическое количество считанных байтов или -1, указывающее на конец файла.
Исключения:: IOException — если произошла ошибка ввода-вывода.

length

public long length()

Возвращает длину базового файла или -1, если она неизвестна.

Определено в:: length в интерфейсе ImageInputStream
Переопределяет:: length в классе ImageInputStreamImpl
Возвращает:: длину файла как long или -1.

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