Класс TIFFImageReadParam

javax.imageio.plugins.tiff.TIFFImageReadParam

public final class TIFFImageReadParam extends ImageReadParam

Подкласс ImageReadParam, позволяющий управлять процессом чтения TIFF.

Поскольку формат TIFF является расширяемым, считывателю необходима информация о тегах, используемых расширениями TIFF, чтобы формировать содержательные метаданные. Кроме того, расширения TIFF могут определять новые типы сжатия. Информация обоих типов, относящаяся к расширениям, может быть предоставлена этим интерфейсом.

Дополнительные теги TIFF должны быть организованы в наборы TIFFTagSet. Набор TIFFTagSet можно передать считывателю с помощью метода addAllowedTagSet. По умолчанию включены наборы тегов BaselineTIFFTagSet, FaxTIFFTagSet, ExifParentTIFFTagSet и GeoTIFFTagSet.

Принудительное чтение полей, соответствующих TIFFTag, отсутствующим во всех разрешённых наборах TIFFTagSet, можно включить с помощью setReadUnknownTags.

С версии:: 9

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

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

canSetSourceRenderSize, destination, destinationBands, minProgressivePass, numProgressivePasses, sourceRenderSize

Модификатор и тип	Поле	Описание
`protected boolean`	`canSetSourceRenderSize`	`true`, если этот `ImageReadParam` позволяет задавать размеры визуализации источника.
`protected BufferedImage`	`destination`	Текущий `BufferedImage` назначения или `null`, если он не задан.
`protected int[]`	`destinationBands`	Набор полос назначения, которые будут использоваться, в виде массива `int`.
`protected int`	`minProgressivePass`	Минимальный индекс прогрессивного прохода для чтения из источника.
`protected int`	`numProgressivePasses`	Максимальное число прогрессивных проходов для чтения из источника.
`protected Dimension`	`sourceRenderSize`	Желаемые ширина и высота визуализации источника, если `canSetSourceRenderSize` равно `true`, или `null`.

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

controller, defaultController, destinationOffset, destinationType, sourceBands, sourceRegion, sourceXSubsampling, sourceYSubsampling, subsamplingXOffset, subsamplingYOffset

Модификатор и тип	Поле	Описание
`protected IIOParamController`	`controller`	`IIOParamController`, который будет использоваться для предоставления настроек этому объекту `IIOParam` при вызове метода `activateController`.
`protected IIOParamController`	`defaultController`	Контроллер `IIOParamController` по умолчанию, который будет использоваться для предоставления настроек этому объекту `IIOParam` при вызове метода `activateController`.
`protected Point`	`destinationOffset`	Смещение в изображении назначения, куда следует поместить декодированный пиксель в левом верхнем углу.
`protected ImageTypeSpecifier`	`destinationType`	Объект `ImageTypeSpecifier`, используемый для создания изображения назначения при чтении или задания выходного типа цвета при записи.
`protected int[]`	`sourceBands`	Массив `int`, указывающий, какие полосы источника будут использоваться, или `null`.
`protected Rectangle`	`sourceRegion`	Область источника; `null`, если она не задана.
`protected int`	`sourceXSubsampling`	Шаг субдискретизации в горизонтальном направлении.
`protected int`	`sourceYSubsampling`	Шаг субдискретизации в вертикальном направлении.
`protected int`	`subsamplingXOffset`	Горизонтальное смещение сетки субдискретизации, применяемое до субдискретизации.
`protected int`	`subsamplingYOffset`	Вертикальное смещение сетки субдискретизации, применяемое до субдискретизации.

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

Конструктор	Описание
`TIFFImageReadParam()`	Создает объект `TIFFImageReadParam`.

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

Модификатор и тип	Метод	Описание
`void`	`addAllowedTagSet(TIFFTagSet tagSet)`	Добавляет объект `TIFFTagSet` в список разрешенных наборов тегов.
`List<TIFFTagSet>`	`getAllowedTagSets()`	Возвращает `List`, содержащий разрешенные объекты `TIFFTagSet`.
`boolean`	`getReadUnknownTags()`	Возвращает значение параметра, определяющего, следует ли читать поля, соответствующие неизвестным `TIFFTag`.
`void`	`removeAllowedTagSet(TIFFTagSet tagSet)`	Удаляет объект `TIFFTagSet` из списка разрешенных наборов тегов.
`void`	`setReadUnknownTags(boolean readUnknownTags)`	Задает, следует ли читать поля, соответствующие `TIFFTag`, не входящим в разрешенные `TIFFTagSet`.

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

canSetSourceRenderSize, getDestination, getDestinationBands, getSourceMaxProgressivePass, getSourceMinProgressivePass, getSourceNumProgressivePasses, getSourceRenderSize, setDestination, setDestinationBands, setSourceProgressivePasses, setSourceRenderSize

Модификатор и тип	Метод	Описание
`boolean`	`canSetSourceRenderSize()`	Возвращает `true`, если этот считыватель позволяет визуализировать исходное изображение с произвольным размером в процессе декодирования с помощью метода `setSourceRenderSize`.
`BufferedImage`	`getDestination()`	Возвращает `BufferedImage`, установленный методом `setDestination`, или `null`, если он не задан.
`int[]`	`getDestinationBands()`	Возвращает набор индексов полос, в которые будут помещены данные.
`int`	`getSourceMaxProgressivePass()`	Если `getSourceNumProgressivePasses` равно `Integer.MAX_VALUE`, возвращает `Integer.MAX_VALUE`.
`int`	`getSourceMinProgressivePass()`	Возвращает индекс первого прогрессивного прохода, который будет декодирован.
`int`	`getSourceNumProgressivePasses()`	Возвращает число прогрессивных проходов, которые будут декодированы.
`Dimension`	`getSourceRenderSize()`	Возвращает ширину и высоту исходного изображения в том виде, в каком оно будет визуализировано при декодировании, если эти значения были заданы с помощью метода `setSourceRenderSize`.
`void`	`setDestination(BufferedImage destination)`	Предоставляет `BufferedImage`, который будет использоваться в качестве назначения для декодированных данных пикселей.
`void`	`setDestinationBands(int[] destinationBands)`	Задает индексы полос назначения, в которые будут помещены данные.
`void`	`setSourceProgressivePasses(int minPass, int numPasses)`	Задает диапазон прогрессивных проходов, которые будут декодированы.
`void`	`setSourceRenderSize(Dimension size)`	Если изображение можно визуализировать с произвольным размером, задает ширину и высоту источника указанными значениями.

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

activateController, getController, getDefaultController, getDestinationOffset, getDestinationType, getSourceBands, getSourceRegion, getSourceXSubsampling, getSourceYSubsampling, getSubsamplingXOffset, getSubsamplingYOffset, hasController, setController, setDestinationOffset, setDestinationType, setSourceBands, setSourceRegion, setSourceSubsampling

Модификатор и тип	Метод	Описание
`boolean`	`activateController()`	Активирует установленный `IIOParamController` для этого объекта `IIOParam` и возвращает полученное значение.
`IIOParamController`	`getController()`	Возвращает установленный в данный момент `IIOParamController`.
`IIOParamController`	`getDefaultController()`	Возвращает контроллер `IIOParamController` по умолчанию, если он существует, независимо от текущего установленного контроллера.
`Point`	`getDestinationOffset()`	Возвращает смещение в изображении назначения, куда следует поместить пиксели.
`ImageTypeSpecifier`	`getDestinationType()`	Возвращает тип изображения, который будет возвращен при чтении, если он был задан вызовом `setDestination(ImageTypeSpecifier)`, в виде объекта `ImageTypeSpecifier`.
`int[]`	`getSourceBands()`	Возвращает набор полос источника, которые будут использоваться.
`Rectangle`	`getSourceRegion()`	Возвращает область источника, которая будет использоваться.
`int`	`getSourceXSubsampling()`	Возвращает число столбцов источника, на которое нужно перейти для каждого пикселя.
`int`	`getSourceYSubsampling()`	Возвращает число строк, на которое нужно перейти для каждого пикселя.
`int`	`getSubsamplingXOffset()`	Возвращает горизонтальное смещение сетки субдискретизации.
`int`	`getSubsamplingYOffset()`	Возвращает вертикальное смещение сетки субдискретизации.
`boolean`	`hasController()`	Возвращает `true`, если для этого объекта `IIOParam` установлен контроллер.
`void`	`setController(IIOParamController controller)`	Задает `IIOParamController`, который будет использоваться для предоставления настроек этому объекту `IIOParam` при вызове метода `activateController`, заменяя контроллер по умолчанию.
`void`	`setDestinationOffset(Point destinationOffset)`	Задает смещение в изображении назначения, куда следует помещать будущие декодированные пиксели при чтении или куда следует записывать область при записи.
`void`	`setDestinationType(ImageTypeSpecifier destinationType)`	Задает желаемый тип изображения для изображения назначения с помощью объекта `ImageTypeSpecifier`.
`void`	`setSourceBands(int[] sourceBands)`	Задает индексы полос источника, которые будут использоваться.
`void`	`setSourceRegion(Rectangle sourceRegion)`	Задает область интереса источника.
`void`	`setSourceSubsampling(int sourceXSubsampling, int sourceYSubsampling, int subsamplingXOffset, int subsamplingYOffset)`	Задает шаг субдискретизации, применяемый при вводе-выводе.

Методы, объявленные в классе 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, либо до истечения заданного интервала времени.

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

TIFFImageReadParam

public TIFFImageReadParam()

Создает TIFFImageReadParam. Будут поддерживаться теги, определенные TIFFTagSets BaselineTIFFTagSet, FaxTIFFTagSet, ExifParentTIFFTagSet и GeoTIFFTagSet.

См. также:

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

addAllowedTagSet

public void addAllowedTagSet(TIFFTagSet tagSet)

Добавляет объект TIFFTagSet в список разрешенных наборов тегов. Попытка добавить в список дублирующий объект не приводит к изменениям.

Параметры:: tagSet — TIFFTagSet.
Исключения:: IllegalArgumentException — если tagSet равен null.

removeAllowedTagSet

public void removeAllowedTagSet(TIFFTagSet tagSet)

Удаляет объект TIFFTagSet из списка разрешенных наборов тегов. Удаление выполняется на основе метода equals объекта TIFFTagSet, который обычно определяется как проверка ссылочного равенства.

Параметры:: tagSet — TIFFTagSet.
Исключения:: IllegalArgumentException — если tagSet равен null.

getAllowedTagSets

public List<TIFFTagSet> getAllowedTagSets()

Возвращает List, содержащий разрешенные объекты TIFFTagSet.

Возвращает:: List объектов TIFFTagSets.

setReadUnknownTags

public void setReadUnknownTags(boolean readUnknownTags)

Задает, следует ли считывать поля, соответствующие TIFFTags, отсутствующим в разрешенных TIFFTagSets. По умолчанию задано значение false. Если TIFF ImageReader игнорирует метаданные, значение true переопределяется, поскольку все метаданные игнорируются, кроме необходимых для чтения самого изображения.

Параметры:: readUnknownTags — следует ли считывать поля нераспознанных тегов

getReadUnknownTags

public boolean getReadUnknownTags()

Возвращает значение настройки, определяющей, следует ли считывать поля, соответствующие неизвестным TIFFTags.

Возвращает:: Следует ли считывать поля нераспознанных тегов

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