Класс FileCacheImageInputStream

java.lang.Object

javax.imageio.stream.ImageInputStreamImpl

javax.imageio.stream.FileCacheImageInputStream

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

public class FileCacheImageInputStream extends ImageInputStreamImpl

Реализация ImageInputStream, получающая входные данные из обычного InputStream. Файл используется для кэширования ранее прочитанных данных.

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

Поля, объявленные в классе javax.imageio.stream.ImageInputStreamImpl

bitOffset, byteOrder, flushedPos, streamPos

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

Конструктор	Описание
`FileCacheImageInputStream(InputStream stream, File cacheDir)`	Создаёт `FileCacheImageInputStream`, который будет читать из заданного `InputStream`.

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

Модификатор и тип	Метод	Описание
`void`	`close()`	Закрывает этот `FileCacheImageInputStream`, закрывая и удаляя файл кэша.
`protected void`	`finalize()`	Устаревший, подлежит удалению: Этот элемент API может быть удалён в будущей версии. Финализация устарела и подлежит удалению.
`boolean`	`isCached()`	Возвращает `true`, так как этот `ImageInputStream` кэширует данные для возможности обратного поиска.
`boolean`	`isCachedFile()`	Возвращает `true`, так как этот `ImageInputStream` поддерживает кэш в файле.
`boolean`	`isCachedMemory()`	Возвращает `false`, так как этот `ImageInputStream` не поддерживает кэш в оперативной памяти.
`int`	`read()`	Считывает один байт из потока и возвращает его как `int` от 0 до 255.
`int`	`read(byte[] b, int off, int len)`	Считывает до `len` байтов из потока и сохраняет их в `b` начиная с индекса `off`.

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

checkClosed, flush, flushBefore, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, length, 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

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

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

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

FileCacheImageInputStream

public FileCacheImageInputStream(InputStream stream, File cacheDir) throws IOException

Создаёт FileCacheImageInputStream , который будет читать из заданного InputStream.

В качестве кэша используется временный файл. Если cacheDir не null и является каталогом, файл будет создан в нём. Если это null, будет использован системный каталог временных файлов (см. документацию для File.createTempFile для подробностей).

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

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

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 для обозначения EOF.
Исключения:: IOException - если произошла ошибка ввода-вывода.

isCached

public boolean isCached()

Возвращает true , так как этот ImageInputStream кэширует данные для возможности обратного поиска.

Определяется:

isCached в интерфейсе ImageInputStream

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

isCached в классе ImageInputStreamImpl

Возвращает:

true.

См. также:

isCachedFile

public boolean isCachedFile()

Возвращает true , так как этот ImageInputStream поддерживает кэш в файле.

Определяется:

isCachedFile в интерфейсе ImageInputStream

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

isCachedFile в классе ImageInputStreamImpl

Возвращает:

true.

См. также:

isCachedMemory

public boolean isCachedMemory()

Возвращает false , так как этот ImageInputStream не поддерживает кэш в оперативной памяти.

Определяется:

isCachedMemory в интерфейсе ImageInputStream

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

isCachedMemory в классе ImageInputStreamImpl

Возвращает:

false.

См. также:

close

public void close() throws IOException

Закрывает этот FileCacheImageInputStream, закрывая и удаляя файл кэша. Источник InputStream не закрывается.

Исключения:: IOException - если произошла ошибка.

finalize

@Deprecated(since="9", forRemoval=true) protected void finalize() throws Throwable

Устаревший, подлежит удалению: Этот элемент API может быть удалён в будущей версии.

Финализация устарела и подлежит удалению. См. Object.finalize() для дополнительной информации и деталей по вариантам миграции.

Финализирует этот объект перед сборкой мусора. Вызывается метод close для закрытия любых открытых источников ввода. Этот метод не должен вызываться кодом приложения.

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

finalize в классе ImageInputStreamImpl

Исключения:

Throwable - если произошла ошибка во время финализации суперкласса.

См. также:

© 1993, 2023, 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/21/docs/api/java.desktop/javax/imageio/stream/FileCacheImageInputStream.html