- java.lang.Object
-
- javax.imageio.IIOParam
-
- javax.imageio.ImageReadParam
-
- javax.imageio.plugins.tiff.TIFFImageReadParam
-
public final class TIFFImageReadParam extends ImageReadParam
A subclass ofImageReadParamallowing 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
TIFFTagSets. ATIFFTagSetmay be provided to the reader by means of theaddAllowedTagSetmethod. By default, the tag setsBaselineTIFFTagSet,FaxTIFFTagSet,ExifParentTIFFTagSet, andGeoTIFFTagSetare included.Forcing reading of fields corresponding to
TIFFTags not in any of the allowedTIFFTagSets may be effected viasetReadUnknownTags.- Since:
- 9
-
-
Field Summary
-
Fields declared in class javax.imageio.ImageReadParam
canSetSourceRenderSize, destination, destinationBands, minProgressivePass, numProgressivePasses, sourceRenderSize
-
Fields declared in class javax.imageio.IIOParam
controller, defaultController, destinationOffset, destinationType, sourceBands, sourceRegion, sourceXSubsampling, sourceYSubsampling, subsamplingXOffset, subsamplingYOffset
-
-
Constructor Summary
Constructors Constructor Description TIFFImageReadParam()Constructs aTIFFImageReadParam.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddAllowedTagSet(TIFFTagSet tagSet)Adds aTIFFTagSetobject to the list of allowed tag sets.List<TIFFTagSet>getAllowedTagSets()Returns aListcontaining the allowedTIFFTagSetobjects.booleangetReadUnknownTags()Retrieve the setting of whether to read fields corresponding to unknownTIFFTags.voidremoveAllowedTagSet(TIFFTagSet tagSet)Removes aTIFFTagSetobject from the list of allowed tag sets.voidsetReadUnknownTags(boolean readUnknownTags)Set whether to read fields corresponding toTIFFTags not in the allowedTIFFTagSets.-
Methods declared in class javax.imageio.ImageReadParam
canSetSourceRenderSize, getDestination, getDestinationBands, getSourceMaxProgressivePass, getSourceMinProgressivePass, getSourceNumProgressivePasses, getSourceRenderSize, setDestination, setDestinationBands, setSourceProgressivePasses, setSourceRenderSize
-
Methods declared in class javax.imageio.IIOParam
activateController, getController, getDefaultController, getDestinationOffset, getDestinationType, getSourceBands, getSourceRegion, getSourceXSubsampling, getSourceYSubsampling, getSubsamplingXOffset, getSubsamplingYOffset, hasController, setController, setDestinationOffset, setDestinationType, setSourceBands, setSourceRegion, setSourceSubsampling
-
-
-
-
Constructor Detail
-
TIFFImageReadParam
public TIFFImageReadParam()
Constructs aTIFFImageReadParam. Tags defined by theTIFFTagSetsBaselineTIFFTagSet,FaxTIFFTagSet,ExifParentTIFFTagSet, andGeoTIFFTagSetwill be supported.- See Also:
BaselineTIFFTagSet,FaxTIFFTagSet,ExifParentTIFFTagSet,GeoTIFFTagSet
-
-
Method Detail
-
addAllowedTagSet
public void addAllowedTagSet(TIFFTagSet tagSet)
Adds aTIFFTagSetobject to the list of allowed tag sets. Attempting to add a duplicate object to the list has no effect.- Parameters:
tagSet- aTIFFTagSet.- Throws:
IllegalArgumentException- iftagSetisnull.
-
removeAllowedTagSet
public void removeAllowedTagSet(TIFFTagSet tagSet)
Removes aTIFFTagSetobject from the list of allowed tag sets. Removal is based on theequalsmethod of theTIFFTagSet, which is normally defined as reference equality.- Parameters:
tagSet- aTIFFTagSet.- Throws:
IllegalArgumentException- iftagSetisnull.
-
getAllowedTagSets
public List<TIFFTagSet> getAllowedTagSets()
Returns aListcontaining the allowedTIFFTagSetobjects.- Returns:
- a
ListofTIFFTagSets.
-
setReadUnknownTags
public void setReadUnknownTags(boolean readUnknownTags)
Set whether to read fields corresponding toTIFFTags not in the allowedTIFFTagSets. The default setting isfalse. If the TIFFImageReaderis ignoring metadata, then a setting oftrueis overridden as all metadata are ignored except those essential to reading the image itself.- Parameters:
readUnknownTags- Whether to read fields of unrecognized tags
-
getReadUnknownTags
public boolean getReadUnknownTags()
Retrieve the setting of whether to read fields corresponding to unknownTIFFTags.- Returns:
- Whether to read fields of unrecognized tags
-
-