com.sun.media.imageio.plugins.tiff
public class TIFFDirectory extends Object implements Cloneable
TIFFDirectory
instance corresponds
to an IFD and contains a set of TIFFFields each of which
corresponds to an IFD Entry in the IFD.
When reading, a TIFFDirectory
may be created by passing
the value returned by javax.imageio.ImageReader#getImageMetadata
ImageReader.getImageMetadata()
to createFromMetadata()
. The TIFFFields in the directory may then
be obtained using the accessor methods provided in this class.
When writing, an IIOMetadata object for use by one of the
TIFFDirectory
by getAsMetadata.
The TIFFDirectory
itself may be created by construction or
from the IIOMetadata
object returned by
javax.imageio.ImageWriter#getDefaultImageMetadata
ImageWriter.getDefaultImageMetadata()
. The TIFFField
s in the
directory may be set using the mutator methods provided in this class.
A TIFFDirectory
is aware of the tag numbers in the
group of TIFFTagSets associated with it. When
a TIFFDirectory
is created from a native image metadata
object, these tag sets are derived from the tagSets attribute
of the TIFFIFD node.
A TIFFDirectory
might also have a parent TIFFTag.
This will occur if the directory represents an IFD other than the root
IFD of the image. The parent tag is the tag of the IFD Entry which is a
pointer to the IFD represented by this TIFFDirectory
. The
TIFFTag method of this parent TIFFTag
must return true
. When a TIFFDirectory
is
created from a native image metadata object, the parent tag set is set
from the parentTagName attribute of the corresponding
TIFFIFD node. Note that a TIFFDirectory
instance
which has a non-null
parent tag will be contained in the
data field of a TIFFField
instance which has a tag field
equal to the contained directory's parent tag.
As an example consider an EXIF image. The TIFFDirectory
instance corresponding to the EXIF IFD in the EXIF stream would have parent
tag TAG_EXIF_IFD_POINTER
and would include EXIFTIFFTagSet in its group of known tag sets.
The TIFFDirectory
corresponding to this EXIF IFD will be
contained in the data field of a TIFFField
which will in turn
be contained in the TIFFDirectory
corresponding to the primary
IFD of the EXIF image which will itself have a null
-valued
parent tag.
Note that this implementation is not synchronized. If multiple
threads use a TIFFDirectory
instance concurrently, and at
least one of the threads modifies the directory, for example, by adding
or removing TIFFField
s or TIFFTagSet
s, it
must be synchronized externally.
Since: 1.1-beta
Constructor Summary | |
---|---|
TIFFDirectory(TIFFTagSet[] tagSets, TIFFTag parentTag)
Constructs a TIFFDirectory which is aware of a given
group of TIFFTagSets. |
Method Summary | |
---|---|
void | addTagSet(TIFFTagSet tagSet)
Adds an element to the group of TIFFTagSets of which this
directory is aware.
|
void | addTIFFField(TIFFField f)
Adds a TIFF field to the directory.
|
Object | clone()
Clones the directory and all the fields contained therein.
|
boolean | containsTIFFField(int tagNumber)
Determines whether a TIFF field with the given tag number is
contained in this directory.
|
static TIFFDirectory | createFromMetadata(IIOMetadata tiffImageMetadata)
Creates a TIFFDirectory instance from the contents of
an image metadata object. |
IIOMetadata | getAsMetadata()
Converts the directory to a metadata object.
|
int | getNumTIFFFields()
Returns the number of TIFFFields in this directory.
|
TIFFTag | getParentTag()
Returns the parent TIFFTag of this directory if one
has been defined or null otherwise.
|
TIFFTag | getTag(int tagNumber)
Returns the TIFFTag which has tag number equal to
tagNumber or null if no such tag
exists in the TIFFTagSets associated with this
directory.
|
TIFFTagSet[] | getTagSets()
Returns the TIFFTagSets of which this directory is aware.
|
TIFFField | getTIFFField(int tagNumber)
Retrieves a TIFF field from the directory.
|
TIFFField[] | getTIFFFields()
Retrieves all TIFF fields from the directory.
|
void | removeTagSet(TIFFTagSet tagSet)
Removes an element from the group of TIFFTagSets of which this
directory is aware.
|
void | removeTIFFField(int tagNumber)
Removes a TIFF field from the directory.
|
void | removeTIFFFields()
Removes all TIFF fields from the directory. |
TIFFDirectory
which is aware of a given
group of TIFFTagSets. An optional parent TIFFTag
may also be specified.
Parameters: tagSets The TIFFTagSets
associated with this
directory. parentTag The parent TIFFTag
of this directory;
may be null
.
Throws: IllegalArgumentException if tagSets
is
null
.
Parameters: tagSet The TIFFTagSet
to add.
Throws: IllegalArgumentException if tagSet
is
null
.
Parameters: f The field to add.
Throws: IllegalArgumentException if f
is null
.
Returns: A clone of this TIFFDirectory
.
Returns: Whether a TIFFTag with tag number equal to
tagNumber
is present in this TIFFDirectory
.
TIFFDirectory
instance from the contents of
an image metadata object. The supplied object must support an image
metadata format supported by the TIFF javax.imageio.ImageWriter
plug-in. This will usually be either the TIFF native image metadata
format com_sun_media_imageio_plugins_tiff_1.0 or the Java
Image I/O standard metadata format javax_imageio_1.0.
Parameters: tiffImageMetadata A metadata object which supports a compatible image metadata format.
Returns: A TIFFDirectory
populated from the contents of
the supplied metadata object.
Throws: IllegalArgumentException if tiffImageMetadata
is null
. IllegalArgumentException if tiffImageMetadata
does not support a compatible image metadata format. IIOInvalidTreeException if the supplied metadata object
cannot be parsed.
Returns: A metadata instance initialized from the contents of this
TIFFDirectory
.
Returns: The number of TIFFField
s in this
TIFFDirectory
.
null
otherwise.
Returns: The parent TIFFTag
of this
TIFFDiectory
or null
.
tagNumber
or null
if no such tag
exists in the TIFFTagSets associated with this
directory.
Parameters: tagNumber The tag number of interest.
Returns: The corresponding TIFFTag
or null
.
Returns: The TIFFTagSet
s associated with this
TIFFDirectory
.
Parameters: tagNumber The tag number of the tag associated with the field.
Returns: A TIFFField
with the requested tag number of
null
if no such field is present.
Returns: An array of all TIFF fields in order of numerically increasing tag number.
Parameters: tagSet The TIFFTagSet
to remove.
Throws: IllegalArgumentException if tagSet
is
null
.
Parameters: tagNumber The tag number of the tag associated with the field.