OpenJDK 27 · com.sun.imageio.plugins.tiff.TIFFImageMetadata

Modifier and Type	Field and Description
private static final String[]	colorSpaceNames
public static final String	NATIVE_METADATA_FORMAT_CLASS_NAME
public static final String	NATIVE_METADATA_FORMAT_NAME
private static final String[]	orientationNames
pack-priv TIFFIFD	rootIFD
private List<TIFFTagSet>	tagSets

Access	Constructor and Description
public	TIFFImageMetadata(List<TIFFTagSet> tagSets)
public	TIFFImageMetadata(TIFFIFD ifd)

Method Summary

Modifier and Type	Method and Description
public void	addShortOrLongField(int tagNumber, long value)
private static void	fatal(Node node, String reason)
public Node	getAsTree(String formatName) Implements abstract javax.imageio.metadata.IIOMetadata.getAsTree. Returns an XML DOM `Node` object that represents the root of a tree of metadata contained within this object according to the conventions defined by a given metadata format.
private static String	getAttribute(Node node, String attrName)
private Node	getChildNode(Node node, String childName)
private Node	getIFDAsTree(TIFFIFD ifd, String parentTagName, int parentTagNumber)
private Node	getNativeTree()
public TIFFIFD	getRootIFD()
public TIFFImageMetadata	getShallowClone() Returns a `TIFFImageMetadata` wherein all fields in the root IFD from the `BaselineTIFFTagSet` are copied by value and all other fields copied by reference.
public IIOMetadataNode	getStandardChromaNode() Overrides javax.imageio.metadata.IIOMetadata.getStandardChromaNode. Returns an `IIOMetadataNode` representing the chroma information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
public IIOMetadataNode	getStandardCompressionNode() Overrides javax.imageio.metadata.IIOMetadata.getStandardCompressionNode. Returns an `IIOMetadataNode` representing the compression information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
public IIOMetadataNode	getStandardDataNode() Overrides javax.imageio.metadata.IIOMetadata.getStandardDataNode. Returns an `IIOMetadataNode` representing the data format information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
public IIOMetadataNode	getStandardDimensionNode() Overrides javax.imageio.metadata.IIOMetadata.getStandardDimensionNode. Returns an `IIOMetadataNode` representing the dimension information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
public IIOMetadataNode	getStandardDocumentNode() Overrides javax.imageio.metadata.IIOMetadata.getStandardDocumentNode. Returns an `IIOMetadataNode` representing the document information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
public IIOMetadataNode	getStandardTextNode() Overrides javax.imageio.metadata.IIOMetadata.getStandardTextNode. Returns an `IIOMetadataNode` representing the textual information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
public IIOMetadataNode	getStandardTransparencyNode() Overrides javax.imageio.metadata.IIOMetadata.getStandardTransparencyNode. Returns an `IIOMetadataNode` representing the transparency information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
public TIFFField	getTIFFField(int tagNumber)
public void	initializeFromStream(ImageInputStream stream, boolean ignoreMetadata, boolean readUnknownTags)
public boolean	isReadOnly() Implements abstract javax.imageio.metadata.IIOMetadata.isReadOnly. Returns `true` if this object does not support the `mergeTree`, `setFromTree`, and `reset` methods.
private char[]	listToCharArray(String list)
private int[]	listToIntArray(String list)
private void	mergeNativeTree(Node root)
private void	mergeStandardTree(Node root)
public void	mergeTree(String formatName, Node root) Implements abstract javax.imageio.metadata.IIOMetadata.mergeTree. Alters the internal state of this `IIOMetadata` object from a tree of XML DOM `Node`s whose syntax is defined by the given metadata format.
public static TIFFIFD	parseIFD(Node node)
public void	removeTIFFField(int tagNumber)
private String	repeat(String s, int times)
public void	reset() Implements abstract javax.imageio.metadata.IIOMetadata.reset. Resets all the data stored in this object to default values, usually to the state this object was in immediately after construction, though the precise semantics are plug-in specific.

Inherited from javax.imageio.metadata.IIOMetadata:: activateController getController getDefaultController getExtraMetadataFormatNames getMetadataFormat getMetadataFormatNames getNativeMetadataFormatName getStandardTileNode getStandardTree hasController isStandardMetadataFormatSupported setController setFromTree

colorSpaceNames	back to summary
private static final String[] colorSpaceNames

orientationNames	back to summary
private static final String[] orientationNames

rootIFD	back to summary
pack-priv TIFFIFD rootIFD

tagSets	back to summary
private List<TIFFTagSet> tagSets

Method Detail

addShortOrLongField	back to summary
public void addShortOrLongField(int tagNumber, long value)

fatal	back to summary
private static void fatal(Node node, String reason) throws IIOInvalidTreeException

getAsTree back to summary

getAsTree	back to summary
public Node getAsTree(String formatName) Implements abstract javax.imageio.metadata.IIOMetadata.getAsTree. Doc from javax.imageio.metadata.IIOMetadata.getAsTree. Returns an XML DOM `Node` object that represents the root of a tree of metadata contained within this object according to the conventions defined by a given metadata format. The names of the available metadata formats may be queried using the `getMetadataFormatNames` method. Annotations @Override

public Node getAsTree(String formatName)

Implements abstract javax.imageio.metadata.IIOMetadata.getAsTree.

Doc from javax.imageio.metadata.IIOMetadata.getAsTree.

Returns an XML DOM Node object that represents the root of a tree of metadata contained within this object according to the conventions defined by a given metadata format.

The names of the available metadata formats may be queried using the getMetadataFormatNames method.

Annotations

@Override

getAttribute	back to summary
private static String getAttribute(Node node, String attrName)

getChildNode	back to summary
private Node getChildNode(Node node, String childName)

getIFDAsTree	back to summary
private Node getIFDAsTree(TIFFIFD ifd, String parentTagName, int parentTagNumber)

getNativeTree	back to summary
private Node getNativeTree()

getRootIFD	back to summary
public TIFFIFD getRootIFD()

getShallowClone	back to summary
public TIFFImageMetadata getShallowClone() Returns a `TIFFImageMetadata` wherein all fields in the root IFD from the `BaselineTIFFTagSet` are copied by value and all other fields copied by reference.

getStandardChromaNode back to summary

getStandardChromaNode	back to summary
public IIOMetadataNode getStandardChromaNode() Overrides javax.imageio.metadata.IIOMetadata.getStandardChromaNode. Doc from javax.imageio.metadata.IIOMetadata.getStandardChromaNode. Returns an `IIOMetadataNode` representing the chroma information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available. This method is intended to be called by the utility routine `getStandardTree`. The default implementation returns `null`. Subclasses should override this method to produce an appropriate subtree if they wish to support the standard metadata format. Annotations @Override

public IIOMetadataNode getStandardChromaNode()

Overrides javax.imageio.metadata.IIOMetadata.getStandardChromaNode.

Doc from javax.imageio.metadata.IIOMetadata.getStandardChromaNode.

Returns an IIOMetadataNode representing the chroma information of the standard javax_imageio_1.0 metadata format, or null if no such information is available. This method is intended to be called by the utility routine getStandardTree.

The default implementation returns null.

Subclasses should override this method to produce an appropriate subtree if they wish to support the standard metadata format.

Annotations

@Override

getStandardCompressionNode back to summary

getStandardCompressionNode	back to summary
public IIOMetadataNode getStandardCompressionNode() Overrides javax.imageio.metadata.IIOMetadata.getStandardCompressionNode. Doc from javax.imageio.metadata.IIOMetadata.getStandardCompressionNode. Returns an `IIOMetadataNode` representing the compression information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available. This method is intended to be called by the utility routine `getStandardTree`. The default implementation returns `null`. Subclasses should override this method to produce an appropriate subtree if they wish to support the standard metadata format. Annotations @Override

public IIOMetadataNode getStandardCompressionNode()

Overrides javax.imageio.metadata.IIOMetadata.getStandardCompressionNode.

Doc from javax.imageio.metadata.IIOMetadata.getStandardCompressionNode.

Returns an IIOMetadataNode representing the compression information of the standard javax_imageio_1.0 metadata format, or null if no such information is available. This method is intended to be called by the utility routine getStandardTree.

The default implementation returns null.

Subclasses should override this method to produce an appropriate subtree if they wish to support the standard metadata format.

Annotations

@Override

getStandardDataNode back to summary

getStandardDataNode	back to summary
public IIOMetadataNode getStandardDataNode() Overrides javax.imageio.metadata.IIOMetadata.getStandardDataNode. Doc from javax.imageio.metadata.IIOMetadata.getStandardDataNode. Returns an `IIOMetadataNode` representing the data format information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available. This method is intended to be called by the utility routine `getStandardTree`. The default implementation returns `null`. Subclasses should override this method to produce an appropriate subtree if they wish to support the standard metadata format. Annotations @Override

public IIOMetadataNode getStandardDataNode()

Overrides javax.imageio.metadata.IIOMetadata.getStandardDataNode.

Doc from javax.imageio.metadata.IIOMetadata.getStandardDataNode.

Returns an IIOMetadataNode representing the data format information of the standard javax_imageio_1.0 metadata format, or null if no such information is available. This method is intended to be called by the utility routine getStandardTree.

The default implementation returns null.

Subclasses should override this method to produce an appropriate subtree if they wish to support the standard metadata format.

Annotations

@Override

getStandardDimensionNode back to summary

getStandardDimensionNode	back to summary
public IIOMetadataNode getStandardDimensionNode() Overrides javax.imageio.metadata.IIOMetadata.getStandardDimensionNode. Doc from javax.imageio.metadata.IIOMetadata.getStandardDimensionNode. Returns an `IIOMetadataNode` representing the dimension information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available. This method is intended to be called by the utility routine `getStandardTree`. The default implementation returns `null`. Subclasses should override this method to produce an appropriate subtree if they wish to support the standard metadata format. Annotations @Override

public IIOMetadataNode getStandardDimensionNode()

Overrides javax.imageio.metadata.IIOMetadata.getStandardDimensionNode.

Doc from javax.imageio.metadata.IIOMetadata.getStandardDimensionNode.

Returns an IIOMetadataNode representing the dimension information of the standard javax_imageio_1.0 metadata format, or null if no such information is available. This method is intended to be called by the utility routine getStandardTree.

The default implementation returns null.

Subclasses should override this method to produce an appropriate subtree if they wish to support the standard metadata format.

Annotations

@Override

getStandardDocumentNode back to summary

getStandardDocumentNode	back to summary
public IIOMetadataNode getStandardDocumentNode() Overrides javax.imageio.metadata.IIOMetadata.getStandardDocumentNode. Doc from javax.imageio.metadata.IIOMetadata.getStandardDocumentNode. Returns an `IIOMetadataNode` representing the document information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available. This method is intended to be called by the utility routine `getStandardTree`. The default implementation returns `null`. Subclasses should override this method to produce an appropriate subtree if they wish to support the standard metadata format. Annotations @Override

public IIOMetadataNode getStandardDocumentNode()

Overrides javax.imageio.metadata.IIOMetadata.getStandardDocumentNode.

Doc from javax.imageio.metadata.IIOMetadata.getStandardDocumentNode.

Returns an IIOMetadataNode representing the document information of the standard javax_imageio_1.0 metadata format, or null if no such information is available. This method is intended to be called by the utility routine getStandardTree.

The default implementation returns null.

Subclasses should override this method to produce an appropriate subtree if they wish to support the standard metadata format.

Annotations

@Override

getStandardTextNode back to summary

getStandardTextNode	back to summary
public IIOMetadataNode getStandardTextNode() Overrides javax.imageio.metadata.IIOMetadata.getStandardTextNode. Doc from javax.imageio.metadata.IIOMetadata.getStandardTextNode. Returns an `IIOMetadataNode` representing the textual information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available. This method is intended to be called by the utility routine `getStandardTree`. The default implementation returns `null`. Subclasses should override this method to produce an appropriate subtree if they wish to support the standard metadata format. Annotations @Override

public IIOMetadataNode getStandardTextNode()

Overrides javax.imageio.metadata.IIOMetadata.getStandardTextNode.

Doc from javax.imageio.metadata.IIOMetadata.getStandardTextNode.

Returns an IIOMetadataNode representing the textual information of the standard javax_imageio_1.0 metadata format, or null if no such information is available. This method is intended to be called by the utility routine getStandardTree.

The default implementation returns null.

Subclasses should override this method to produce an appropriate subtree if they wish to support the standard metadata format.

Annotations

@Override

getStandardTransparencyNode back to summary

getStandardTransparencyNode	back to summary
public IIOMetadataNode getStandardTransparencyNode() Overrides javax.imageio.metadata.IIOMetadata.getStandardTransparencyNode. Doc from javax.imageio.metadata.IIOMetadata.getStandardTransparencyNode. Returns an `IIOMetadataNode` representing the transparency information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available. This method is intended to be called by the utility routine `getStandardTree`. The default implementation returns `null`. Subclasses should override this method to produce an appropriate subtree if they wish to support the standard metadata format. Annotations @Override

public IIOMetadataNode getStandardTransparencyNode()

Overrides javax.imageio.metadata.IIOMetadata.getStandardTransparencyNode.

Doc from javax.imageio.metadata.IIOMetadata.getStandardTransparencyNode.

Returns an IIOMetadataNode representing the transparency information of the standard javax_imageio_1.0 metadata format, or null if no such information is available. This method is intended to be called by the utility routine getStandardTree.

The default implementation returns null.

Subclasses should override this method to produce an appropriate subtree if they wish to support the standard metadata format.

Annotations

@Override

getTIFFField	back to summary
public TIFFField getTIFFField(int tagNumber)

initializeFromStream	back to summary
public void initializeFromStream(ImageInputStream stream, boolean ignoreMetadata, boolean readUnknownTags) throws IOException

isReadOnly back to summary

isReadOnly	back to summary
public boolean isReadOnly() Implements abstract javax.imageio.metadata.IIOMetadata.isReadOnly. Doc from javax.imageio.metadata.IIOMetadata.isReadOnly. Returns `true` if this object does not support the `mergeTree`, `setFromTree`, and `reset` methods. Annotations @Override

public boolean isReadOnly()

Implements abstract javax.imageio.metadata.IIOMetadata.isReadOnly.

Doc from javax.imageio.metadata.IIOMetadata.isReadOnly.

Returns true if this object does not support the mergeTree, setFromTree, and reset methods.

Annotations

@Override

listToCharArray	back to summary
private char[] listToCharArray(String list)

listToIntArray	back to summary
private int[] listToIntArray(String list)

mergeNativeTree	back to summary
private void mergeNativeTree(Node root) throws IIOInvalidTreeException

mergeStandardTree	back to summary
private void mergeStandardTree(Node root) throws IIOInvalidTreeException

mergeTree back to summary

mergeTree	back to summary
public void mergeTree(String formatName, Node root) throws IIOInvalidTreeException Implements abstract javax.imageio.metadata.IIOMetadata.mergeTree. Doc from javax.imageio.metadata.IIOMetadata.mergeTree. Alters the internal state of this `IIOMetadata` object from a tree of XML DOM `Node`s whose syntax is defined by the given metadata format. The previous state is altered only as necessary to accommodate the nodes that are present in the given tree. If the tree structure or contents are invalid, an `IIOInvalidTreeException` will be thrown. As the semantics of how a tree or subtree may be merged with another tree are completely format-specific, plug-in authors may implement this method in whatever manner is most appropriate for the format, including simply replacing all existing state with the contents of the given tree. Annotations @Override Exceptions IIOInvalidTreeException: if the tree cannot be parsed successfully using the rules of the given format.

public void mergeTree(String formatName, Node root) throws IIOInvalidTreeException

Implements abstract javax.imageio.metadata.IIOMetadata.mergeTree.

Doc from javax.imageio.metadata.IIOMetadata.mergeTree.

Alters the internal state of this IIOMetadata object from a tree of XML DOM Nodes whose syntax is defined by the given metadata format. The previous state is altered only as necessary to accommodate the nodes that are present in the given tree. If the tree structure or contents are invalid, an IIOInvalidTreeException will be thrown.

As the semantics of how a tree or subtree may be merged with another tree are completely format-specific, plug-in authors may implement this method in whatever manner is most appropriate for the format, including simply replacing all existing state with the contents of the given tree.

Annotations

@Override

Exceptions

IIOInvalidTreeException:: if the tree cannot be parsed successfully using the rules of the given format.

parseIFD	back to summary
public static TIFFIFD parseIFD(Node node) throws IIOInvalidTreeException

removeTIFFField	back to summary
public void removeTIFFField(int tagNumber)

repeat	back to summary
private String repeat(String s, int times)

reset	back to summary
public void reset() Implements abstract javax.imageio.metadata.IIOMetadata.reset. Doc from javax.imageio.metadata.IIOMetadata.reset. Resets all the data stored in this object to default values, usually to the state this object was in immediately after construction, though the precise semantics are plug-in specific. Note that there are many possible default values, depending on how the object was created. Annotations @Override

reset

back to summary

public void reset()

Implements abstract javax.imageio.metadata.IIOMetadata.reset.

Doc from javax.imageio.metadata.IIOMetadata.reset.

Resets all the data stored in this object to default values, usually to the state this object was in immediately after construction, though the precise semantics are plug-in specific. Note that there are many possible default values, depending on how the object was created.

Annotations

@Override

public Class TIFFImageMetadata

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail