Class TIFFTag

public static final int TIFF_BYTE

Flag for 8 bit unsigned integers.

public static final int TIFF_ASCII

Flag for null-terminated ASCII strings.

public static final int TIFF_SHORT

Flag for 16 bit unsigned integers.

public static final int TIFF_LONG

Flag for 32 bit unsigned integers.

public static final int TIFF_RATIONAL

Flag for pairs of 32 bit unsigned integers.

public static final int TIFF_SBYTE

Flag for 8 bit signed integers.

public static final int TIFF_UNDEFINED

Flag for 8 bit uninterpreted bytes.

public static final int TIFF_SSHORT

Flag for 16 bit signed integers.

public static final int TIFF_SLONG

Flag for 32 bit signed integers.

public static final int TIFF_SRATIONAL

Flag for pairs of 32 bit signed integers.

public static final int TIFF_FLOAT

Flag for 32 bit IEEE floats.

public static final int TIFF_DOUBLE

Flag for 64 bit IEEE doubles.

public static final int TIFF_IFD_POINTER

Flag for IFD pointer defined in TIFF Tech Note 1 in TIFF Specification Supplement 1.

public static final int MIN_DATATYPE

The numerically smallest constant representing a TIFF data type.

public static final int MAX_DATATYPE

The numerically largest constant representing a TIFF data type.

public static final String UNKNOWN_TAG_NAME

The name assigned to a tag with an unknown tag number. Such a tag may be created for example when reading an IFD and a tag number is encountered which is not in any of the TIFFTagSets known to the reader.

public TIFFTag(String name, int number, int dataTypes, int count)

Constructs a TIFFTag with a given name, tag number, set of legal data types, and value count. A negative value count signifies that either an arbitrary number of values is legal or the required count is determined by the values of other fields in the IFD. A non-negative count specifies the number of values which an associated field must contain. The tag will have no associated TIFFTagSet.

If there are mnemonic names to be associated with the legal data values for the tag, addValueName() should be called on the new instance for each name. Mnemonic names apply only to tags which have integral data type.

See the documentation for getDataTypes() for an explanation of how the set of data types is to be converted into a bit mask.

public TIFFTag(String name, int number, TIFFTagSet tagSet)

Constructs a TIFFTag with a given name, tag number and TIFFTagSet to which it refers. The legal data types are set to include TIFF_LONG and TIFF_IFD_POINTER and the value count is unity. The TIFFTagSet will represent the set of TIFFTags which appear in the IFD pointed to. A TIFFTag represents an IFD pointer if and only if tagSet is non-null or the data type TIFF_IFD_POINTER is legal.

public TIFFTag(String name, int number, int dataTypes)

Constructs a TIFFTag with a given name, tag number, and set of legal data types. The value count of the tag will be undefined and it will have no associated TIFFTagSet.

public static int getSizeOfType(int dataType)

Returns the number of bytes used to store a value of the given data type.

public String getName()

Returns the name of the tag, as it will appear in image metadata.

public int getNumber()

Returns the integer used to represent the tag.

public int getDataTypes()

Returns a bit mask indicating the set of data types that may be used to store the data associated with the tag. For example, a tag that can store both SHORT and LONG values would return a value of:

 (1 << TIFFTag.TIFF_SHORT) | (1 << TIFFTag.TIFF_LONG)
 

public int getCount()

Returns the value count of this tag. If this value is positive, it represents the required number of values for a TIFFField which has this tag. If the value is negative, the count is undefined. In the latter case the count may be derived, e.g., the number of values of the BitsPerSample field is SamplesPerPixel, or it may be variable as in the case of most US-ASCII fields.

public boolean isDataTypeOK(int dataType)

Returns true if the given data type may be used for the data associated with this tag.

public TIFFTagSet getTagSet()

Returns the TIFFTagSet of which this tag is a part.

public boolean isIFDPointer()

Returns true if this tag is used to point to an IFD structure containing additional tags. A TIFFTag represents an IFD pointer if and only if its TIFFTagSet is non-null or the data type TIFF_IFD_POINTER is legal. This condition will be satisfied if and only if either getTagSet() != null or isDataTypeOK(TIFF_IFD_POINTER) == true.

Many TIFF extensions use the IFD mechanism in order to limit the number of new tags that may appear in the root IFD.

public boolean hasValueNames()

Returns true if there are mnemonic names associated with the set of legal values for the data associated with this tag. Mnemonic names apply only to tags which have integral data type.

protected void addValueName(int value, String name)

Adds a mnemonic name for a particular value that this tag's data may take on. Mnemonic names apply only to tags which have integral data type.

public String getValueName(int value)

Returns the mnemonic name associated with a particular value that this tag's data may take on, or null if no name is present. Mnemonic names apply only to tags which have integral data type.

public int[] getNamedValues()

Returns an array of values for which mnemonic names are defined. The method getValueName() will return non-null only for values contained in the returned array. Mnemonic names apply only to tags which have integral data type.