Класс ImageOutputStreamSpi

public abstract class ImageOutputStreamSpi
extends IIOServiceProvider

Интерфейс поставщика сервисов (SPI) для ImageOutputStream. Дополнительную информацию об интерфейсах поставщиков сервисов см. в комментарии к классу IIORegistry.

Этот интерфейс позволяет произвольным объектам «обертываться» экземплярами ImageOutputStream. Например, определённый ImageOutputStreamSpi может позволить использовать универсальный OutputStream в качестве пункта назначения; другой может выводить данные в File или на устройство, например, последовательный порт.

Обращаясь к созданию ImageOutputStream как к подключаемому сервису, становится возможным обрабатывать будущие пункты назначения вывода без изменения API. Также, высокопроизводительные реализации ImageOutputStream (например, нативные реализации для определённой платформы) могут быть установлены и использованы приложениями прозрачно.

Поля

outputClass

protected Class<?> outputClass

Объект Class, указывающий допустимый тип объекта для использования методом createInputStreamInstance.

Конструкторы

ImageOutputStreamSpi

protected ImageOutputStreamSpi()

Создаёт пустой ImageOutputStreamSpi . Подклассу необходимо инициализировать переменные экземпляра и/или переопределять реализации методов, чтобы предоставить рабочие версии всех методов.

ImageOutputStreamSpi

public ImageOutputStreamSpi(String vendorName,
                            String version,
                            Class<?> outputClass)

Создаёт ImageOutputStreamSpi с заданным набором значений.

Параметры:

vendorName - имя поставщика.

version - идентификатор версии.

outputClass - объект Class, указывающий допустимый тип объекта для использования методом createOutputStreamInstance.

Исключения:

IllegalArgumentException - если vendorName равен null.

IllegalArgumentException - если version равен null.

Методы

getOutputClass

public Class<?> getOutputClass()

Возвращает:

переменная Class.

См. также:

createOutputStreamInstance(Object, boolean, File)

canUseCacheFile

public boolean canUseCacheFile()

Возвращает:

true если файл кеша может быть использован потоками вывода, созданными этим поставщиком сервисов.

needsCacheFile

public boolean needsCacheFile()

Возвращает:

true если файл кеша необходим потокам вывода, созданными этим поставщиком сервисов.

createOutputStreamInstance

public abstract ImageOutputStream createOutputStreamInstance(Object output,
                                                             boolean useCache,
                                                             File cacheDir)
                                                      throws IOException

Возвращает экземпляр реализации ImageOutputStream , связанной с этим поставщиком сервисов. Если использование файла кеша является необязательным, будет использоваться параметр useCache. В случаях, когда кеш необходим или не применим, значение useCache будет проигнорировано.

Параметры:

output - объект типа класса, возвращённого методом getOutputClass.

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

cacheDir - File , указывающий, где должен быть создан файл кеша, или null для использования системного каталога.

Возвращает:

экземпляр ImageOutputStream.

Исключения:

IllegalArgumentException - если output не является экземпляром правильного класса или является null.

IllegalArgumentException - если требуется файл кеша, но cacheDir не является экземпляром null и не является каталогом.

IOException - если файл кеша не может быть создан.

См. также:

getOutputClass()

createOutputStreamInstance

public ImageOutputStream createOutputStreamInstance(Object output)
                                             throws IOException

Возвращает экземпляр реализации ImageOutputStream , связанной с этим поставщиком сервисов. Файл кеша будет создан в системно-зависимой папке временных файлов по умолчанию, если необходимо.

Параметры:

output - объект типа класса, возвращённого методом getOutputClass.

Возвращает:

экземпляр ImageOutputStream.

Исключения:

IllegalArgumentException - если output не является экземпляром правильного класса или является null.

IOException - если файл кеша не может быть создан.

См. также:

getOutputClass()