public class

BMPMetadata

extends IIOMetadata
implements BMPConstants
java.lang.Object
   ↳ javax.imageio.metadata.IIOMetadata
     ↳ com.sun.imageio.plugins.bmp.BMPMetadata

Summary

Constants
String nativeMetadataFormatName
[Expand]
Inherited Constants
From interface com.sun.imageio.plugins.bmp.BMPConstants
Fields
public int alphaMask
public short bitsPerPixel
public int blue
public int blueMask
public double blueX
public double blueY
public double blueZ
public String bmpVersion
public int colorSpace
public int colorsImportant
public int colorsUsed
public List comments
public int compression
public int gammaBlue
public int gammaGreen
public int gammaRed
public int green
public int greenMask
public double greenX
public double greenY
public double greenZ
public int height
public int imageSize
public int intent
public byte[] palette
public int paletteSize
public int red
public int redMask
public double redX
public double redY
public double redZ
public int width
public int xPixelsPerMeter
public int yPixelsPerMeter
[Expand]
Inherited Fields
From class javax.imageio.metadata.IIOMetadata
From interface com.sun.imageio.plugins.bmp.BMPConstants
Public Constructors
BMPMetadata()
Public Methods
Node getAsTree(String formatName)
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.
boolean isReadOnly()
Returns true if this object does not support the mergeTree, setFromTree, and reset methods.
void mergeTree(String formatName, Node root)
Alters the internal state of this IIOMetadata object from a tree of XML DOM Nodes whose syntax is defined by the given metadata format.
void 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.
void setFromTree(String formatName, Node root)
Sets the internal state of this IIOMetadata object from a tree of XML DOM Nodes whose syntax is defined by the given metadata format.
Protected Methods
IIOMetadataNode 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.
IIOMetadataNode 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.
IIOMetadataNode 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.
IIOMetadataNode 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.
[Expand]
Inherited Methods
From class javax.imageio.metadata.IIOMetadata
From class java.lang.Object

Constants

public static final String nativeMetadataFormatName

Constant Value: "javax_imageio_bmp_1.0"

Fields

public int alphaMask

public short bitsPerPixel

public int blue

public int blueMask

public double blueX

public double blueY

public double blueZ

public String bmpVersion

public int colorSpace

public int colorsImportant

public int colorsUsed

public List comments

public int compression

public int gammaBlue

public int gammaGreen

public int gammaRed

public int green

public int greenMask

public double greenX

public double greenY

public double greenZ

public int height

public int imageSize

public int intent

public byte[] palette

public int paletteSize

public int red

public int redMask

public double redX

public double redY

public double redZ

public int width

public int xPixelsPerMeter

public int yPixelsPerMeter

Public Constructors

public BMPMetadata ()

Public Methods

public Node getAsTree (String formatName)

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 the desired metadata format.
Returns
  • an XML DOM Node object forming the root of a tree.

public boolean isReadOnly ()

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

Returns
  • true if this IIOMetadata object cannot be modified.

public void mergeTree (String formatName, Node root)

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 accomodate 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 the desired metadata format.
root an XML DOM Node object forming the root of a tree.

public void 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.

public void setFromTree (String formatName, Node root)

Sets 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 discarded. If the tree's structure or contents are invalid, an IIOInvalidTreeException will be thrown.

The default implementation calls reset followed by mergeTree(formatName, root).

Parameters
formatName the desired metadata format.
root an XML DOM Node object forming the root of a tree.

Protected Methods

protected IIOMetadataNode 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.

Returns
  • an IIOMetadataNode, or null.

protected IIOMetadataNode 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.

Returns
  • an IIOMetadataNode, or null.

protected IIOMetadataNode 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.

Returns
  • an IIOMetadataNode, or null.

protected IIOMetadataNode 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
  • an IIOMetadataNode, or null.