Top Fields Constructors Methods
org.apache.pdfbox.jbig2

public Class JBIG2ImageMetadata

extends IIOMetadata
Class Inheritance
Imports
javax.imageio.metadata.IIOMetadata, .IIOMetadataFormatImpl, .IIOMetadataNode, org.w3c.dom.Node
See Also
IIOMetadata

Field Summary

Modifier and TypeField and Description
pack-priv static final String
IMAGE_METADATA_FORMAT_NAME

private final JBIG2Page
page

Inherited from javax.imageio.metadata.IIOMetadata:
controllerdefaultControllerextraMetadataFormatClassNamesextraMetadataFormatNamesnativeMetadataFormatClassNamenativeMetadataFormatNamestandardFormatSupported

Constructor Summary

AccessConstructor and Description
public
JBIG2ImageMetadata(JBIG2Page page)

Method Summary

Modifier and TypeMethod and Description
public Node
getAsTree(String
the desired metadata format.
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 Node
getNativeTree()

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 boolean
isReadOnly()

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

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

public void
mergeTree(String
the desired metadata format.
formatName, Node
an XML DOM Node object forming the root of a tree.
root)

Implements abstract 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.

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:
activateControllergetControllergetDefaultControllergetExtraMetadataFormatNamesgetMetadataFormatgetMetadataFormatNamesgetNativeMetadataFormatNamegetStandardChromaNodegetStandardCompressionNodegetStandardDataNodegetStandardDocumentNodegetStandardTextNodegetStandardTileNodegetStandardTransparencyNodegetStandardTreehasControllerisStandardMetadataFormatSupportedsetControllersetFromTree

Field Detail

IMAGE_METADATA_FORMAT_NAMEback to summary
pack-priv static final String IMAGE_METADATA_FORMAT_NAME
pageback to summary
private final JBIG2Page page

Constructor Detail

JBIG2ImageMetadataback to summary
public JBIG2ImageMetadata(JBIG2Page page)

Method Detail

getAsTreeback 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.

Parameters
formatName:String

the desired metadata format.

Returns:Node

an XML DOM Node object forming the root of a tree.

Annotations
@Override
getNativeTreeback to summary
private Node getNativeTree()
getStandardDimensionNodeback 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.

Returns:IIOMetadataNode

an IIOMetadataNode, or null.

Annotations
@Override
isReadOnlyback 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.

Returns:boolean

true if this IIOMetadata object cannot be modified.

Annotations
@Override
mergeTreeback to summary
public void mergeTree(String formatName, Node root)

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.

Parameters
formatName:String

the desired metadata format.

root:Node

an XML DOM Node object forming the root of a tree.

Annotations
@Override
resetback 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