java.lang.Object
javax.imageio.plugins.tiff.TIFFTag
A class defining the notion of a TIFF tag. A TIFF tag is a key
that may appear in an Image File Directory (IFD). In the IFD
each tag has some data associated with it, which may consist of zero
or more values of a given data type. The combination of a tag and a
value is known as an IFD Entry or TIFF Field.
The actual tag values used in the root IFD of a standard ("baseline")
tiff stream are defined in the BaselineTIFFTagSet
class.
- Since:
- 9
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The numerically largest constant representing a TIFF data type.static final int
The numerically smallest constant representing a TIFF data type.static final int
Flag for null-terminated ASCII strings.static final int
Flag for 8 bit unsigned integers.static final int
Flag for 64 bit IEEE doubles.static final int
Flag for 32 bit IEEE floats.static final int
Flag for IFD pointer defined in TIFF Tech Note 1 in TIFF Specification Supplement 1.static final int
Flag for 32 bit unsigned integers.static final int
Flag for pairs of 32 bit unsigned integers.static final int
Flag for 8 bit signed integers.static final int
Flag for 16 bit unsigned integers.static final int
Flag for 32 bit signed integers.static final int
Flag for pairs of 32 bit signed integers.static final int
Flag for 16 bit signed integers.static final int
Flag for 8 bit uninterpreted bytes.static final String
The name assigned to a tag with an unknown tag number. -
Constructor Summary
ConstructorDescriptionConstructs aTIFFTag
with a given name, tag number, and set of legal data types.Constructs aTIFFTag
with a given name, tag number, set of legal data types, and value count.TIFFTag
(String name, int number, TIFFTagSet tagSet) Constructs aTIFFTag
with a given name, tag number andTIFFTagSet
to which it refers. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addValueName
(int value, String name) Adds a mnemonic name for a particular value that this tag's data may take on.int
getCount()
Returns the value count of this tag.int
Returns a bit mask indicating the set of data types that may be used to store the data associated with the tag.getName()
Returns the name of the tag, as it will appear in image metadata.int[]
Returns an array of values for which mnemonic names are defined.int
Returns the integer used to represent the tag.static int
getSizeOfType
(int dataType) Returns the number of bytes used to store a value of the given data type.Returns theTIFFTagSet
of which this tag is a part.getValueName
(int value) Returns the mnemonic name associated with a particular value that this tag's data may take on, ornull
if no name is present.boolean
Returnstrue
if there are mnemonic names associated with the set of legal values for the data associated with this tag.boolean
isDataTypeOK
(int dataType) Returnstrue
if the given data type may be used for the data associated with this tag.boolean
Returnstrue
if this tag is used to point to an IFD structure containing additional tags.
-
Field Details
-
TIFF_BYTE
public static final int TIFF_BYTEFlag for 8 bit unsigned integers.- See Also:
-
TIFF_ASCII
public static final int TIFF_ASCIIFlag for null-terminated ASCII strings.- See Also:
-
TIFF_SHORT
public static final int TIFF_SHORTFlag for 16 bit unsigned integers.- See Also:
-
TIFF_LONG
public static final int TIFF_LONGFlag for 32 bit unsigned integers.- See Also:
-
TIFF_RATIONAL
public static final int TIFF_RATIONALFlag for pairs of 32 bit unsigned integers.- See Also:
-
TIFF_SBYTE
public static final int TIFF_SBYTEFlag for 8 bit signed integers.- See Also:
-
TIFF_UNDEFINED
public static final int TIFF_UNDEFINEDFlag for 8 bit uninterpreted bytes.- See Also:
-
TIFF_SSHORT
public static final int TIFF_SSHORTFlag for 16 bit signed integers.- See Also:
-
TIFF_SLONG
public static final int TIFF_SLONGFlag for 32 bit signed integers.- See Also:
-
TIFF_SRATIONAL
public static final int TIFF_SRATIONALFlag for pairs of 32 bit signed integers.- See Also:
-
TIFF_FLOAT
public static final int TIFF_FLOATFlag for 32 bit IEEE floats.- See Also:
-
TIFF_DOUBLE
public static final int TIFF_DOUBLEFlag for 64 bit IEEE doubles.- See Also:
-
TIFF_IFD_POINTER
public static final int TIFF_IFD_POINTERFlag for IFD pointer defined in TIFF Tech Note 1 in TIFF Specification Supplement 1.- See Also:
-
MIN_DATATYPE
public static final int MIN_DATATYPEThe numerically smallest constant representing a TIFF data type.- See Also:
-
MAX_DATATYPE
public static final int MAX_DATATYPEThe numerically largest constant representing a TIFF data type.- See Also:
-
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 theTIFFTagSet
s known to the reader.- See Also:
-
-
Constructor Details
-
TIFFTag
Constructs aTIFFTag
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 associatedTIFFTagSet
.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.- Parameters:
name
- the name of the tag.number
- the number used to represent the tag.dataTypes
- a bit mask indicating the set of legal data types for this tag.count
- the value count for this tag.- Throws:
NullPointerException
- if name is null.IllegalArgumentException
- if number is negative or dataTypes is negative or specifies an out of range type.
-
TIFFTag
Constructs aTIFFTag
with a given name, tag number andTIFFTagSet
to which it refers. The legal data types are set to includeTIFF_LONG
andTIFF_IFD_POINTER
and the value count is unity. TheTIFFTagSet
will represent the set ofTIFFTag
s which appear in the IFD pointed to. ATIFFTag
represents an IFD pointer if and only iftagSet
is non-null
or the data typeTIFF_IFD_POINTER
is legal.- Parameters:
name
- the name of the tag.number
- the number used to represent the tag.tagSet
- theTIFFTagSet
to which this tag belongs.- Throws:
NullPointerException
- if name or tagSet is null.IllegalArgumentException
- if number is negative.- See Also:
-
TIFFTag
Constructs aTIFFTag
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 associatedTIFFTagSet
.- Parameters:
name
- the name of the tag.number
- the number used to represent the tag.dataTypes
- a bit mask indicating the set of legal data types for this tag.- Throws:
NullPointerException
- if name is null.IllegalArgumentException
- if number is negative or dataTypes is negative or specifies an out of range type.- See Also:
-
-
Method Details
-
getSizeOfType
public static int getSizeOfType(int dataType) Returns the number of bytes used to store a value of the given data type.- Parameters:
dataType
- the data type to be queried.- Returns:
- the number of bytes used to store the given data type.
- Throws:
IllegalArgumentException
- ifdatatype
is less thanMIN_DATATYPE
or greater thanMAX_DATATYPE
.
-
getName
Returns the name of the tag, as it will appear in image metadata.- Returns:
- the tag name, as a
String
.
-
getNumber
public int getNumber()Returns the integer used to represent the tag.- Returns:
- the tag number, as an
int
.
-
getDataTypes
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)
- Returns:
- an
int
containing a bitmask encoding the set of valid data types.
-
getCount
public int getCount()Returns the value count of this tag. If this value is positive, it represents the required number of values for aTIFFField
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 theBitsPerSample
field isSamplesPerPixel
, or it may be variable as in the case of mostUS-ASCII
fields.- Returns:
- the value count of this tag.
-
isDataTypeOK
public boolean isDataTypeOK(int dataType) Returnstrue
if the given data type may be used for the data associated with this tag.- Parameters:
dataType
- the data type to be queried, one ofTIFF_BYTE
,TIFF_SHORT
, etc.- Returns:
- a
boolean
indicating whether the given data type may be used with this tag. - Throws:
IllegalArgumentException
- ifdatatype
is less thanMIN_DATATYPE
or greater thanMAX_DATATYPE
.
-
getTagSet
Returns theTIFFTagSet
of which this tag is a part.- Returns:
- the containing
TIFFTagSet
.
-
isIFDPointer
public boolean isIFDPointer()Returnstrue
if this tag is used to point to an IFD structure containing additional tags. ATIFFTag
represents an IFD pointer if and only if itsTIFFTagSet
is non-null
or the data typeTIFF_IFD_POINTER
is legal. This condition will be satisfied if and only if eithergetTagSet() != null
orisDataTypeOK(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.
- Returns:
true
if this tag points to an IFD.
-
hasValueNames
public boolean hasValueNames()Returnstrue
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.- Returns:
true
if mnemonic value names are available.
-
addValueName
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.- Parameters:
value
- the data value.name
- the name to associate with the value.
-
getValueName
Returns the mnemonic name associated with a particular value that this tag's data may take on, ornull
if no name is present. Mnemonic names apply only to tags which have integral data type.- Parameters:
value
- the data value.- Returns:
- the mnemonic name associated with the value, as a
String
.
-
getNamedValues
public int[] getNamedValues()Returns an array of values for which mnemonic names are defined. The methodgetValueName()
will return non-null
only for values contained in the returned array. Mnemonic names apply only to tags which have integral data type.- Returns:
- the values for which there is a mnemonic name.
-