Класс ImageWriterSpi

public abstract class ImageWriterSpi
extends ImageReaderWriterSpi

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

Каждый ImageWriterSpi предоставляет несколько типов информации о классе ImageWriter, с которым он связан.

Название поставщика SPI и краткое описание класса доступны через методы getVendorName, getDescription, и getVersion. Эти методы могут быть локализованы для предоставления локализованного вывода. Эти методы предназначены в основном для предоставления краткой, понятной человеку информации, которая может использоваться для организации всплывающего меню или другого списка.

Список имен форматов, расширений файлов и MIME-типов, связанных с сервисом, можно получить с помощью методов getFormatNames, getFileSuffixes, и getMIMEType. Эти методы могут быть использованы для идентификации потенциальных ImageWriter для записи конкретного файла или потока на основе ручного выбора формата, именования файла или ассоциаций MIME.

Более надёжный способ определить, какие ImageWriter могут обработать конкретный поток данных, предоставляется методом canEncodeImage. Этот метод позволяет поставщику сервиса проверить фактическое содержимое изображения.

Наконец, экземпляр класса ImageWriter, связанного с этим поставщиком сервиса, может быть получен вызовом метода createWriterInstance. Любая ресурсоёмкая инициализация, такая как загрузка нативных библиотек или создание больших таблиц, должна быть отложена как минимум до первого вызова этого метода.

Поля

STANDARD_OUTPUT_TYPE

@Deprecated
public static final Class[] STANDARD_OUTPUT_TYPE

Устаревшее. Вместо использования этого поля, создайте напрямую эквивалентный массив { ImageOutputStream.class }.

Массив из одного элемента, изначально содержащий ImageOutputStream.class, который должен возвращаться методом getOutputTypes.

outputTypes

protected Class[] outputTypes

Массив объектов Class для возврата методом getOutputTypes, изначально null.

readerSpiNames

protected String[] readerSpiNames

Массив строк, возвращаемый методом getImageReaderSpiNames, изначально null.

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

ImageWriterSpi

protected ImageWriterSpi()

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

ImageWriterSpi

public ImageWriterSpi(String vendorName,
                      String version,
                      String[] names,
                      String[] suffixes,
                      String[] MIMETypes,
                      String writerClassName,
                      Class[] outputTypes,
                      String[] readerSpiNames,
                      boolean supportsStandardStreamMetadataFormat,
                      String nativeStreamMetadataFormatName,
                      String nativeStreamMetadataFormatClassName,
                      String[] extraStreamMetadataFormatNames,
                      String[] extraStreamMetadataFormatClassNames,
                      boolean supportsStandardImageMetadataFormat,
                      String nativeImageMetadataFormatName,
                      String nativeImageMetadataFormatClassName,
                      String[] extraImageMetadataFormatNames,
                      String[] extraImageMetadataFormatClassNames)

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

Параметры:

vendorName - имя поставщика, как не-null String.

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

names - не-null массив String , указывающих имена форматов. Должен быть представлен хотя бы один элемент.

suffixes - массив String , указывающих общие расширения файлов. Если расширения не определены, должен быть предоставлен null. Массив длиной 0 будет нормализован до null.

MIMETypes - массив String , указывающих MIME-типы формата. Если расширения не определены, должен быть предоставлен null. Массив длиной 0 будет нормализован до null.

writerClassName - полное имя связанного класса ImageWriterSpi , как не-null String.

outputTypes - массив объектов Class длиной не менее 1, указывающих допустимые типы вывода.

readerSpiNames - массив String длиной не менее 1, содержащий имена классов всех связанных ImageReader или null. Массив длиной 0 нормализуется до null.

supportsStandardStreamMetadataFormat - boolean , указывающий, может ли объект метаданных потока использовать деревья, описанные стандартным форматом метаданных.

nativeStreamMetadataFormatName - String, или null, для возврата методом getNativeStreamMetadataFormatName.

nativeStreamMetadataFormatClassName - String, или null, для использования при создании объекта формата метаданных, для возврата методом getNativeStreamMetadataFormat.

extraStreamMetadataFormatNames - массив String , или null, для возврата методом getExtraStreamMetadataFormatNames. Массив длиной 0 нормализуется до null.

extraStreamMetadataFormatClassNames - массив String , или null, для использования при создании объекта формата метаданных, для возврата методом getStreamMetadataFormat. Массив длиной 0 нормализуется до null.

supportsStandardImageMetadataFormat - boolean , указывающий, может ли объект метаданных изображения использовать деревья, описанные стандартным форматом метаданных.

nativeImageMetadataFormatName - String, или null, для возврата методом getNativeImageMetadataFormatName.

nativeImageMetadataFormatClassName - String, или null, для использования при создании объекта формата метаданных, для возврата методом getNativeImageMetadataFormat.

extraImageMetadataFormatNames - массив String для возврата методом getExtraImageMetadataFormatNames. Массив длиной 0 нормализуется до null.

extraImageMetadataFormatClassNames - массив String , или null, для использования при создании объекта формата метаданных, для возврата методом getImageMetadataFormat. Массив длиной 0 нормализуется до null.

Исключения:

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

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

IllegalArgumentException - если names равно null или имеет длину 0.

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

IllegalArgumentException - если outputTypes равно null или имеет длину 0.

Методы

isFormatLossless

public boolean isFormatLossless()

Возвращает true , если формат, который выводит этот записыватель, сохраняет данные пикселей с точностью до бита. По умолчанию возвращает true.

Возвращает:

true , если формат сохраняет полную точность пикселей.

getOutputTypes

public Class[] getOutputTypes()

Возвращает:

не-null массив объектов Class длиной не менее 1.

canEncodeImage

public abstract boolean canEncodeImage(ImageTypeSpecifier type)

Параметры:

type - ImageTypeSpecifier , определяющий компоновку записываемого изображения.

Возвращает:

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

Исключения:

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

canEncodeImage

public boolean canEncodeImage(RenderedImage im)

Параметры:

im - экземпляр RenderedImage для кодирования.

Возвращает:

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

Исключения:

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

createWriterInstance

public ImageWriter createWriterInstance()
                                 throws IOException

Возвращает:

экземпляр ImageWriter.

Исключения:

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

createWriterInstance

public abstract ImageWriter createWriterInstance(Object extension)
                                          throws IOException

Параметры:

extension - объект расширения, специфичный для плагина, который может быть null.

Возвращает:

экземпляр ImageWriter.

Исключения:

IOException - если попытка создания записывателя не удалась.

IllegalArgumentException - если конструктор ImageWriter вызывает IllegalArgumentException , чтобы указать, что объект расширения непригоден.

isOwnWriter

public boolean isOwnWriter(ImageWriter writer)

Возвращает true , если объект ImageWriter , переданный в качестве параметра, является экземпляром ImageWriter , связанным с этим поставщиком услуг.

Параметры:

writer - экземпляр ImageWriter.

Возвращает:

true , если writer распознан

Исключения:

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

getImageReaderSpiNames

public String[] getImageReaderSpiNames()

Возвращает:

массив Strings длиной не менее 1, содержащий имена ImageReaderSpis, или null.

См. также:

ImageIO.getImageReader(ImageWriter), ImageReaderSpi.getImageWriterSpiNames()