public final class TIFFImageReadParam extends ImageReadParam
ImageReadParam
allowing control over the TIFF reading process. Because TIFF is an extensible format, the reader requires information about any tags used by TIFF extensions in order to emit meaningful metadata. Also, TIFF extensions may define new compression types. Both types of information about extensions may be provided by this interface.
Additional TIFF tags must be organized into TIFFTagSet
s. A TIFFTagSet
may be provided to the reader by means of the addAllowedTagSet
method. By default, the tag sets BaselineTIFFTagSet
, FaxTIFFTagSet
, ExifParentTIFFTagSet
, and GeoTIFFTagSet
are included.
Forcing reading of fields corresponding to TIFFTag
s not in any of the allowed TIFFTagSet
s may be effected via setReadUnknownTags
.
canSetSourceRenderSize, destination, destinationBands, minProgressivePass, numProgressivePasses, sourceRenderSize
controller, defaultController, destinationOffset, destinationType, sourceBands, sourceRegion, sourceXSubsampling, sourceYSubsampling, subsamplingXOffset, subsamplingYOffset
Constructor | Description |
---|---|
TIFFImageReadParam() |
Constructs a TIFFImageReadParam . |
Modifier and Type | Method | Description |
---|---|---|
void |
addAllowedTagSet |
Adds a TIFFTagSet object to the list of allowed tag sets. |
List |
getAllowedTagSets() |
Returns a List containing the allowed TIFFTagSet objects. |
boolean |
getReadUnknownTags() |
Retrieve the setting of whether to read fields corresponding to unknown TIFFTag s. |
void |
removeAllowedTagSet |
Removes a TIFFTagSet object from the list of allowed tag sets. |
void |
setReadUnknownTags |
Set whether to read fields corresponding to TIFFTag s not in the allowed TIFFTagSet s. |
canSetSourceRenderSize, getDestination, getDestinationBands, getSourceMaxProgressivePass, getSourceMinProgressivePass, getSourceNumProgressivePasses, getSourceRenderSize, setDestination, setDestinationBands, setSourceProgressivePasses, setSourceRenderSize
activateController, getController, getDefaultController, getDestinationOffset, getDestinationType, getSourceBands, getSourceRegion, getSourceXSubsampling, getSourceYSubsampling, getSubsamplingXOffset, getSubsamplingYOffset, hasController, setController, setDestinationOffset, setDestinationType, setSourceBands, setSourceRegion, setSourceSubsampling
public TIFFImageReadParam()
TIFFImageReadParam
. Tags defined by the TIFFTagSet
s BaselineTIFFTagSet
, FaxTIFFTagSet
, ExifParentTIFFTagSet
, and GeoTIFFTagSet
will be supported.public void addAllowedTagSet(TIFFTagSet tagSet)
TIFFTagSet
object to the list of allowed tag sets. Attempting to add a duplicate object to the list has no effect.tagSet
- a TIFFTagSet
.IllegalArgumentException
- if tagSet
is null
.public void removeAllowedTagSet(TIFFTagSet tagSet)
TIFFTagSet
object from the list of allowed tag sets. Removal is based on the equals
method of the TIFFTagSet
, which is normally defined as reference equality.tagSet
- a TIFFTagSet
.IllegalArgumentException
- if tagSet
is null
.public List<TIFFTagSet> getAllowedTagSets()
List
containing the allowed TIFFTagSet
objects.List
of TIFFTagSet
s.public void setReadUnknownTags(boolean readUnknownTags)
TIFFTag
s not in the allowed TIFFTagSet
s. The default setting is false
. If the TIFF ImageReader
is ignoring metadata, then a setting of true
is overridden as all metadata are ignored except those essential to reading the image itself.readUnknownTags
- Whether to read fields of unrecognized tagspublic boolean getReadUnknownTags()
TIFFTag
s.
© 1993, 2023, 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/21/docs/api/java.desktop/javax/imageio/plugins/tiff/TIFFImageReadParam.html