| java.lang.Object
 com.sun.media.imageio.plugins.tiff.TIFFTag
| TIFFTag | | public class TIFFTag (Code) | | 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
BaselineTIFFTagSetBaselineTIFFTagSet class.
See Also: BaselineTIFFTagSet
See Also: TIFFField
See Also: TIFFTagSet |
| Field Summary | |
| final public static int | MAX_DATATYPE
The numerically largest constant representing a TIFF data type. | | final public static int | MIN_DATATYPE
The numerically smallest constant representing a TIFF data type. | | final public static int | TIFF_ASCII
Flag for null-terminated ASCII strings. | | final public static int | TIFF_BYTE
Flag for 8 bit unsigned integers. | | final public static int | TIFF_DOUBLE
Flag for 64 bit IEEE doubles. | | final public static int | TIFF_FLOAT
Flag for 32 bit IEEE floats. | | final public static int | TIFF_IFD_POINTER
Flag for IFD pointer defined in TIFF Tech Note 1 in
TIFF Specification Supplement 1. | | final public static int | TIFF_LONG
Flag for 32 bit unsigned integers. | | final public static int | TIFF_RATIONAL
Flag for pairs of 32 bit unsigned integers. | | final public static int | TIFF_SBYTE
Flag for 8 bit signed integers. | | final public static int | TIFF_SHORT
Flag for 16 bit unsigned integers. | | final public static int | TIFF_SLONG
Flag for 32 bit signed integers. | | final public static int | TIFF_SRATIONAL
Flag for pairs of 32 bit signed integers. | | final public static int | TIFF_SSHORT
Flag for 16 bit signed integers. | | final public static int | TIFF_UNDEFINED
Flag for 8 bit uninterpreted bytes. | | int | dataTypes
| | String | name
| | int | number
| | TIFFTagSet | tagSet
| | Map | valueNames
|
| Constructor Summary | |
| public | TIFFTag(String name, int number, int dataTypes, TIFFTagSet tagSet)
Constructs a TIFFTag with a given name, tag number, set
of legal data types, and TIFFTagSet to which it refers.
The tagSet parameter will generally be
non-null only if this TIFFTag corresponds
to a pointer to a TIFF IFD. | | public | TIFFTag(String name, int number, int dataTypes)
Constructs a TIFFTag with a given name, tag
number, and set of legal data types. |
| Method Summary | |
| protected void | addValueName(int value, String name)
Adds a mnemonic name for a particular value that this tag's
data may take on. | | 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. | | 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 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. | | public TIFFTagSet | getTagSet()
Returns the TIFFTagSet of which this tag is a part. | | 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.
Parameters:
value - the data value. | | public boolean | hasValueNames()
Returns true if there are mnemonic names associated with
the set of legal values for the data associated with this tag. | | public boolean | isDataTypeOK(int dataType)
Returns true 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. | | public boolean | isIFDPointer()
Returns true if this tag is used to point to an IFD
structure containing additional tags. |
| MAX_DATATYPE | | final public static int MAX_DATATYPE(Code) | | The numerically largest constant representing a TIFF data type.
|
| MIN_DATATYPE | | final public static int MIN_DATATYPE(Code) | | The numerically smallest constant representing a TIFF data type.
|
| TIFF_ASCII | | final public static int TIFF_ASCII(Code) | | Flag for null-terminated ASCII strings.
|
| TIFF_BYTE | | final public static int TIFF_BYTE(Code) | | Flag for 8 bit unsigned integers.
|
| TIFF_DOUBLE | | final public static int TIFF_DOUBLE(Code) | | Flag for 64 bit IEEE doubles.
|
| TIFF_FLOAT | | final public static int TIFF_FLOAT(Code) | | Flag for 32 bit IEEE floats.
|
| TIFF_IFD_POINTER | | final public static int TIFF_IFD_POINTER(Code) | | Flag for IFD pointer defined in TIFF Tech Note 1 in
TIFF Specification Supplement 1.
|
| TIFF_LONG | | final public static int TIFF_LONG(Code) | | Flag for 32 bit unsigned integers.
|
| TIFF_RATIONAL | | final public static int TIFF_RATIONAL(Code) | | Flag for pairs of 32 bit unsigned integers.
|
| TIFF_SBYTE | | final public static int TIFF_SBYTE(Code) | | Flag for 8 bit signed integers.
|
| TIFF_SHORT | | final public static int TIFF_SHORT(Code) | | Flag for 16 bit unsigned integers.
|
| TIFF_SLONG | | final public static int TIFF_SLONG(Code) | | Flag for 32 bit signed integers.
|
| TIFF_SRATIONAL | | final public static int TIFF_SRATIONAL(Code) | | Flag for pairs of 32 bit signed integers.
|
| TIFF_SSHORT | | final public static int TIFF_SSHORT(Code) | | Flag for 16 bit signed integers.
|
| TIFF_UNDEFINED | | final public static int TIFF_UNDEFINED(Code) | | Flag for 8 bit uninterpreted bytes.
|
| TIFFTag | | public TIFFTag(String name, int number, int dataTypes, TIFFTagSet tagSet)(Code) | | Constructs a TIFFTag with a given name, tag number, set
of legal data types, and TIFFTagSet to which it refers.
The tagSet parameter will generally be
non-null only if this TIFFTag corresponds
to a pointer to a TIFF IFD. In this case tagSet 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.
If there are mnemonic names to be associated with the legal
data values for the tag,
TIFFTag.addValueName(int,String)addValueName() should be called on the new instance
for each name.
See the documentation for
TIFFTag.getDataTypes()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; may be null.
Parameters:
number - the number used to represent the tag.
Parameters:
dataTypes - a bit mask indicating the set of legal datatypes for this tag.
Parameters:
tagSet - the TIFFTagSet to which this tagbelongs; may be null. |
| TIFFTag | | public TIFFTag(String name, int number, int dataTypes)(Code) | | Constructs a TIFFTag with a given name, tag
number, and set of legal data types. The tag will have no
associated TIFFTagSet.
Parameters:
name - the name of the tag; may be null.
Parameters:
number - the number used to represent the tag.
Parameters:
dataTypes - a bit mask indicating the set of legal datatypes for this tag.
See Also: TIFFTag.TIFFTag(String,int,int,TIFFTagSet) |
| addValueName | | protected void addValueName(int value, String name)(Code) | | Adds a mnemonic name for a particular value that this tag's
data may take on.
Parameters:
value - the data value.
Parameters:
name - the name to associate with the value. |
| getDataTypes | | public int getDataTypes()(Code) | | 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)
an int containing a bitmask encoding theset of valid data types. |
| getName | | public String getName()(Code) | | Returns the name of the tag, as it will appear in image metadata.
the tag name, as a String. |
| getNumber | | public int getNumber()(Code) | | Returns the integer used to represent the tag.
the tag number, as an int. |
| getSizeOfType | | public static int getSizeOfType(int dataType)(Code) | | Returns the number of bytes used to store a value of the given
data type.
Parameters:
dataType - the data type to be queried. the number of bytes used to store the given data type.
throws:
IllegalArgumentException - if datatype isless than MIN_DATATYPE or greater thanMAX_DATATYPE. |
| getTagSet | | public TIFFTagSet getTagSet()(Code) | | Returns the TIFFTagSet of which this tag is a part.
the containing TIFFTagSet. |
| getValueName | | public String getValueName(int value)(Code) | | Returns the mnemonic name associated with a particular value
that this tag's data may take on, or null if
no name is present.
Parameters:
value - the data value. the mnemonic name associated with the value, as aString. |
| hasValueNames | | public boolean hasValueNames()(Code) | | Returns true if there are mnemonic names associated with
the set of legal values for the data associated with this tag.
true if mnemonic value names are available. |
| isDataTypeOK | | public boolean isDataTypeOK(int dataType)(Code) | | Returns true 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. a boolean indicating whether the givendata type may be used with this tag.
throws:
IllegalArgumentException - if datatype isless than MIN_DATATYPE or greater thanMAX_DATATYPE. |
| isIFDPointer | | public boolean isIFDPointer()(Code) | | Returns true if this tag is used to point to an IFD
structure containing additional tags. This condition will be
satisfied if and only if either
getTagSet() != null or
isDataTypeOK(TIFF_IFD_POINTER) == true.
Many TIFF extensions use this mechanism in order to limit the
number of new tags that may appear in the root IFD.
true if this tag points to an IFD. |
|
|