Spec-Zone.ru › OpenJDK 25

Класс TIFFTag

java.lang.Object
javax.imageio.plugins.tiff.TIFFTag
public class TIFFTag extends Object
Класс, определяющий понятие тега TIFF. Тег TIFF — это ключ, который может присутствовать в каталоге файлов изображений (IFD). Каждый тег в IFD связан с некоторыми данными, которые могут состоять из нуля или более значений заданного типа данных. Сочетание тега и значения называется записью IFD или полем TIFF.

Фактические значения тегов, используемые в корневом IFD стандартного потока TIFF («базового»), определены в классе BaselineTIFFTagSet.

Начиная с:
9
См. также:
  • BaselineTIFFTagSet
  • TIFFField
  • TIFFTagSet

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

Модификатор и тип Поле Описание
static final int MAX_DATATYPE
Наибольшая по числовому значению константа, представляющая тип данных TIFF.
static final int MIN_DATATYPE
Наименьшая по числовому значению константа, представляющая тип данных TIFF.
static final int TIFF_ASCII
Флаг для строк ASCII с завершающим нулевым байтом.
static final int TIFF_BYTE
Флаг для 8-разрядных целых чисел без знака.
static final int TIFF_DOUBLE
Флаг для 64-разрядных чисел двойной точности IEEE.
static final int TIFF_FLOAT
Флаг для 32-разрядных чисел с плавающей точкой IEEE.
static final int TIFF_IFD_POINTER
Флаг для указателя IFD, определённого в технической заметке 1 к дополнению 1 спецификации TIFF.
static final int TIFF_LONG
Флаг для 32-разрядных целых чисел без знака.
static final int TIFF_RATIONAL
Флаг для пар 32-разрядных целых чисел без знака.
static final int TIFF_SBYTE
Флаг для 8-разрядных целых чисел со знаком.
static final int TIFF_SHORT
Флаг для 16-разрядных целых чисел без знака.
static final int TIFF_SLONG
Флаг для 32-разрядных целых чисел со знаком.
static final int TIFF_SRATIONAL
Флаг для пар 32-разрядных целых чисел со знаком.
static final int TIFF_SSHORT
Флаг для 16-разрядных целых чисел со знаком.
static final int TIFF_UNDEFINED
Флаг для 8-разрядных байтов без интерпретации.
static final String UNKNOWN_TAG_NAME
Имя, присваиваемое тегу с неизвестным номером.

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

Конструктор Описание
TIFFTag(String name, int number, int dataTypes)
Создаёт TIFFTag с заданным именем, номером тега и набором допустимых типов данных.
TIFFTag(String name, int number, int dataTypes, int count)
Создаёт TIFFTag с заданным именем, номером тега, набором допустимых типов данных и количеством значений.
TIFFTag(String name, int number, TIFFTagSet tagSet)
Создаёт TIFFTag с заданными именем, номером тега и TIFFTagSet, на который он ссылается.

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

Модификатор и тип Метод Описание
protected void addValueName(int value, String name)
Добавляет мнемоническое имя для определённого значения, которое могут принимать данные этого тега.
int getCount()
Возвращает количество значений этого тега.
int getDataTypes()
Возвращает битовую маску, указывающую набор типов данных, которые можно использовать для хранения данных, связанных с тегом.
String getName()
Возвращает имя тега в том виде, в котором оно будет отображаться в метаданных изображения.
int[] getNamedValues()
Возвращает массив значений, для которых определены мнемонические имена.
int getNumber()
Возвращает целое число, используемое для представления тега.
static int getSizeOfType(int dataType)
Возвращает количество байтов, используемых для хранения значения заданного типа данных.
TIFFTagSet getTagSet()
Возвращает TIFFTagSet, частью которого является этот тег.
String getValueName(int value)
Возвращает мнемоническое имя, связанное с определённым значением, которое могут принимать данные этого тега, или null, если имя отсутствует.
boolean hasValueNames()
Возвращает true, если с набором допустимых значений данных, связанных с этим тегом, сопоставлены мнемонические имена.
boolean isDataTypeOK(int dataType)
Возвращает true, если указанный тип данных можно использовать для данных, связанных с этим тегом.
boolean isIFDPointer()
Возвращает true, если этот тег используется для указания на структуру IFD, содержащую дополнительные теги.

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

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

Подробное описание полей

TIFF_BYTE

public static final int TIFF_BYTE
Флаг для 8-разрядных целых чисел без знака.
См. также:
  • Значения констант

TIFF_ASCII

public static final int TIFF_ASCII
Флаг для строк ASCII с завершающим нулевым байтом.
См. также:
  • Значения констант

TIFF_SHORT

public static final int TIFF_SHORT
Флаг для 16-разрядных целых чисел без знака.
См. также:
  • Значения констант

TIFF_LONG

public static final int TIFF_LONG
Флаг для 32-разрядных целых чисел без знака.
См. также:
  • Значения констант

TIFF_RATIONAL

public static final int TIFF_RATIONAL
Флаг для пар 32-разрядных целых чисел без знака.
См. также:
  • Значения констант

TIFF_SBYTE

public static final int TIFF_SBYTE
Флаг для 8-разрядных целых чисел со знаком.
См. также:
  • Значения констант

TIFF_UNDEFINED

public static final int TIFF_UNDEFINED
Флаг для 8-разрядных байтов без интерпретации.
См. также:
  • Значения констант

TIFF_SSHORT

public static final int TIFF_SSHORT
Флаг для 16-разрядных целых чисел со знаком.
См. также:
  • Значения констант

TIFF_SLONG

public static final int TIFF_SLONG
Флаг для 32-разрядных целых чисел со знаком.
См. также:
  • Значения констант

TIFF_SRATIONAL

public static final int TIFF_SRATIONAL
Флаг для пар 32-разрядных целых чисел со знаком.
См. также:
  • Значения констант

TIFF_FLOAT

public static final int TIFF_FLOAT
Флаг для 32-разрядных чисел с плавающей точкой IEEE.
См. также:
  • Значения констант

TIFF_DOUBLE

public static final int TIFF_DOUBLE
Флаг для 64-разрядных чисел двойной точности IEEE.
См. также:
  • Значения констант

TIFF_IFD_POINTER

public static final int TIFF_IFD_POINTER
Флаг для указателя IFD, определённого в технической заметке 1 к дополнению 1 спецификации TIFF.
См. также:
  • Значения констант

MIN_DATATYPE

public static final int MIN_DATATYPE
Наименьшая по числовому значению константа, представляющая тип данных TIFF.
См. также:
  • Значения констант

MAX_DATATYPE

public static final int MAX_DATATYPE
Наибольшая по числовому значению константа, представляющая тип данных TIFF.
См. также:
  • Значения констант

UNKNOWN_TAG_NAME

public static final String UNKNOWN_TAG_NAME
Имя, присваиваемое тегу с неизвестным номером. Такой тег может быть создан, например, при чтении IFD, если встретился номер тега, отсутствующий во всех известных считывателю наборах TIFFTagSet.
См. также:
  • Значения констант

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

TIFFTag

public TIFFTag(String name, int number, int dataTypes, int count)
Создаёт TIFFTag с заданными именем, номером тега, набором допустимых типов данных и количеством значений. Отрицательное количество значений означает, что допустимо либо произвольное количество значений, либо требуемое количество определяется значениями других полей в IFD. Неотрицательное количество задаёт число значений, которое должно содержаться в связанном поле. С тегом не будет связан TIFFTagSet.

Если с допустимыми значениями данных тега необходимо связать мнемонические имена, для каждого имени следует вызвать addValueName() у нового экземпляра. Мнемонические имена применяются только к тегам с целочисленным типом данных.

Объяснение преобразования набора типов данных в битовую маску см. в документации к getDataTypes().

Параметры:
name — имя тега.
number — число, используемое для представления тега.
dataTypes — битовая маска, указывающая набор допустимых типов данных для этого тега.
count — количество значений этого тега.
Исключения:
NullPointerException — если name равно null.
IllegalArgumentException — если number или dataTypes отрицательно либо указывает тип вне допустимого диапазона.

TIFFTag

public TIFFTag(String name, int number, TIFFTagSet tagSet)
Создаёт TIFFTag с заданными именем, номером тега и TIFFTagSet, на который он ссылается. В набор допустимых типов данных включаются TIFF_LONG и TIFF_IFD_POINTER, а количество значений устанавливается равным единице. TIFFTagSet будет представлять набор TIFFTag, присутствующих в IFD, на который указывает ссылка. TIFFTag представляет указатель IFD тогда и только тогда, когда tagSet не равен null или допустим тип данных TIFF_IFD_POINTER.
Параметры:
name — имя тега.
number — число, используемое для представления тега.
tagSet — TIFFTagSet, которому принадлежит этот тег.
Исключения:
NullPointerException — если name или tagSet равно null.
IllegalArgumentException — если number отрицательно.
См. также:
  • TIFFTag(String, int, int, int)

TIFFTag

public TIFFTag(String name, int number, int dataTypes)
Создаёт TIFFTag с заданными именем, номером тега и набором допустимых типов данных. Количество значений тега не определено, связанный с ним TIFFTagSet отсутствует.
Параметры:
name — имя тега.
number — число, используемое для представления тега.
dataTypes — битовая маска, указывающая набор допустимых типов данных для этого тега.
Исключения:
NullPointerException — если name равно null.
IllegalArgumentException — если number или dataTypes отрицательно либо указывает тип вне допустимого диапазона.
См. также:
  • TIFFTag(String, int, int, int)

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

getSizeOfType

public static int getSizeOfType(int dataType)
Возвращает количество байтов, используемых для хранения значения заданного типа данных.
Параметры:
dataType — тип данных, размер которого требуется определить.
Возвращает:
количество байтов, используемых для хранения данных указанного типа.
Исключения:
IllegalArgumentException — если datatype меньше MIN_DATATYPE или больше MAX_DATATYPE.

getName

public String getName()
Возвращает имя тега в том виде, в котором оно будет отображаться в метаданных изображения.
Возвращает:
имя тега в виде String.

getNumber

public int getNumber()
Возвращает целое число, используемое для представления тега.
Возвращает:
номер тега в виде int.

getDataTypes

public int getDataTypes()
Возвращает битовую маску, указывающую набор типов данных, которые можно использовать для хранения данных, связанных с тегом. Например, тег, способный хранить значения SHORT и LONG, вернёт значение: 
(1 << TIFFTag.TIFF_SHORT) | (1 << TIFFTag.TIFF_LONG)
Возвращает:
int, содержащий битовую маску, кодирующую набор допустимых типов данных.

getCount

public int getCount()
Возвращает количество значений этого тега. Если это значение положительное, оно задаёт требуемое количество значений для TIFFField, содержащего этот тег. Если значение отрицательное, количество не определено. В последнем случае количество может быть выведено, например, количество значений поля BitsPerSample равно SamplesPerPixel, либо оно может быть переменным, как в случае большинства полей US-ASCII.
Возвращает:
количество значений этого тега.

isDataTypeOK

public boolean isDataTypeOK(int dataType)
Возвращает true, если указанный тип данных можно использовать для данных, связанных с этим тегом.
Параметры:
dataType — тип данных, который требуется проверить: один из TIFF_BYTE, TIFF_SHORT и т. д.
Возвращает:
boolean, указывающий, можно ли использовать указанный тип данных с этим тегом.
Исключения:
IllegalArgumentException — если datatype меньше MIN_DATATYPE или больше MAX_DATATYPE.

getTagSet

public TIFFTagSet getTagSet()
Возвращает TIFFTagSet, частью которого является этот тег.
Возвращает:
содержащий набор TIFFTagSet.

isIFDPointer

public boolean isIFDPointer()
Возвращает true, если этот тег используется для указания на структуру IFD, содержащую дополнительные теги. TIFFTag представляет указатель IFD тогда и только тогда, когда его TIFFTagSet не равен null или допустим тип данных TIFF_IFD_POINTER. Это условие выполняется тогда и только тогда, когда выполняется getTagSet() != null или isDataTypeOK(TIFF_IFD_POINTER) == true.

Многие расширения TIFF используют механизм IFD, чтобы ограничить количество новых тегов, которые могут присутствовать в корневом IFD.

Возвращает:
true, если этот тег указывает на IFD.

hasValueNames

public boolean hasValueNames()
Возвращает true, если с набором допустимых значений данных, связанных с этим тегом, сопоставлены мнемонические имена. Мнемонические имена применяются только к тегам с целочисленным типом данных.
Возвращает:
true, если мнемонические имена значений доступны.

addValueName

protected void addValueName(int value, String name)
Добавляет мнемоническое имя для определённого значения, которое могут принимать данные этого тега. Мнемонические имена применяются только к тегам с целочисленным типом данных.
Параметры:
value — значение данных.
name — имя, связываемое со значением.

getValueName

public String getValueName(int value)
Возвращает мнемоническое имя, связанное с определённым значением, которое могут принимать данные этого тега, или null, если имя отсутствует. Мнемонические имена применяются только к тегам с целочисленным типом данных.
Параметры:
value — значение данных.
Возвращает:
мнемоническое имя, связанное со значением, в виде String.

getNamedValues

public int[] getNamedValues()
Возвращает массив значений, для которых определены мнемонические имена. Метод getValueName() вернёт значение, отличное от null, только для значений, содержащихся в возвращённом массиве. Мнемонические имена применяются только к тегам с целочисленным типом данных.
Возвращает:
значения, для которых определено мнемоническое имя.

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в разделе документации Java SE, содержащем более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и работающие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/javax/imageio/plugins/tiff/TIFFTag.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API