BMPMetadata (SCIFIO Javadocs 0-SNAPSHOT API)

java.lang.Object
- javax.imageio.metadata.IIOMetadata
- - io.scif.media.imageioimpl.plugins.bmp.BMPMetadata

All Implemented Interfaces:: BMPConstants, Cloneable

public class BMPMetadata
extends IIOMetadata
implements Cloneable, BMPConstants

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`alphaMask`
`short`	`bitsPerPixel`
`int`	`blue`
`int`	`blueMask`
`double`	`blueX`
`double`	`blueY`
`double`	`blueZ`
`String`	`bmpVersion`
`int`	`colorsImportant`
`int`	`colorSpace`
`int`	`colorsUsed`
`List`	`comments`
`int`	`compression`
`int`	`gammaBlue`
`int`	`gammaGreen`
`int`	`gammaRed`
`int`	`green`
`int`	`greenMask`
`double`	`greenX`
`double`	`greenY`
`double`	`greenZ`
`int`	`height`
`int`	`imageSize`
`int`	`intent`
`static String`	`nativeMetadataFormatName`
`byte[]`	`palette`
`int`	`paletteSize`
`int`	`red`
`int`	`redMask`
`double`	`redX`
`double`	`redY`
`double`	`redZ`
`int`	`width`
`int`	`xPixelsPerMeter`
`int`	`yPixelsPerMeter`

Fields inherited from class javax.imageio.metadata.IIOMetadata
controller, defaultController, extraMetadataFormatClassNames, extraMetadataFormatNames, nativeMetadataFormatClassName, standardFormatSupported

Fields inherited from interface io.scif.media.imageioimpl.plugins.bmp.BMPConstants
BI_BITFIELDS, BI_JPEG, BI_PNG, BI_RGB, BI_RLE4, BI_RLE8, compressionTypeNames, LCS_CALIBRATED_RGB, LCS_sRGB, LCS_WINDOWS_COLOR_SPACE, PROFILE_EMBEDDED, PROFILE_LINKED, VERSION_2, VERSION_3, VERSION_3_NT, VERSION_4, VERSION_5

Constructor Summary

Constructors
Constructor and Description

BMPMetadata()

BMPMetadata(IIOMetadata metadata)

Constructors
Constructor and Description
`BMPMetadata()`
`BMPMetadata(IIOMetadata metadata)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`Node`	`getAsTree(String formatName)`
`protected IIOMetadataNode`	`getStandardChromaNode()`
`protected IIOMetadataNode`	`getStandardCompressionNode()`
`protected IIOMetadataNode`	`getStandardDataNode()`
`protected IIOMetadataNode`	`getStandardDimensionNode()`
`protected IIOMetadataNode`	`getStandardDocumentNode()`
`protected IIOMetadataNode`	`getStandardTextNode()`
`protected IIOMetadataNode`	`getStandardTransparencyNode()`
`boolean`	`isReadOnly()`
`void`	`mergeTree(String formatName, Node root)`
`void`	`reset()`

Methods inherited from class javax.imageio.metadata.IIOMetadata
activateController, getController, getDefaultController, getExtraMetadataFormatNames, getMetadataFormat, getMetadataFormatNames, getNativeMetadataFormatName, getStandardTileNode, getStandardTree, hasController, isStandardMetadataFormatSupported, setController, setFromTree

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nativeMetadataFormatName

public static final String nativeMetadataFormatName

See Also:: Constant Field Values

bmpVersion
```
public String bmpVersion
```

width
```
public int width
```

height
```
public int height
```

bitsPerPixel
```
public short bitsPerPixel
```

compression
```
public int compression
```

imageSize
```
public int imageSize
```

xPixelsPerMeter
```
public int xPixelsPerMeter
```

yPixelsPerMeter
```
public int yPixelsPerMeter
```

colorsUsed
```
public int colorsUsed
```

colorsImportant
```
public int colorsImportant
```

redMask
```
public int redMask
```

greenMask
```
public int greenMask
```

blueMask
```
public int blueMask
```

alphaMask
```
public int alphaMask
```

colorSpace
```
public int colorSpace
```

redX
```
public double redX
```

redY
```
public double redY
```

redZ
```
public double redZ
```

greenX
```
public double greenX
```

greenY
```
public double greenY
```

greenZ
```
public double greenZ
```

blueX
```
public double blueX
```

blueY
```
public double blueY
```

blueZ
```
public double blueZ
```

gammaRed
```
public int gammaRed
```

gammaGreen
```
public int gammaGreen
```

gammaBlue
```
public int gammaBlue
```

intent
```
public int intent
```

palette
```
public byte[] palette
```

paletteSize
```
public int paletteSize
```

red
```
public int red
```

green
```
public int green
```

blue
```
public int blue
```

comments
```
public List comments
```

Constructor Detail

BMPMetadata
```
public BMPMetadata()
```

BMPMetadata

public BMPMetadata(IIOMetadata metadata)
            throws IIOInvalidTreeException

Throws:: IIOInvalidTreeException

Method Detail
- isReadOnly
```
public boolean isReadOnly()
```
  Specified by:
  
  isReadOnly in class IIOMetadata
- clone
```
public Object clone()
```
  Overrides:
  
  clone in class Object
- getAsTree
```
public Node getAsTree(String formatName)
```
  Specified by:
  
  getAsTree in class IIOMetadata
- getStandardChromaNode
```
protected IIOMetadataNode getStandardChromaNode()
```
  Overrides:
  
  getStandardChromaNode in class IIOMetadata
- getStandardCompressionNode
```
protected IIOMetadataNode getStandardCompressionNode()
```
  Overrides:
  
  getStandardCompressionNode in class IIOMetadata
- getStandardDataNode
```
protected IIOMetadataNode getStandardDataNode()
```
  Overrides:
  
  getStandardDataNode in class IIOMetadata
- getStandardDimensionNode
```
protected IIOMetadataNode getStandardDimensionNode()
```
  Overrides:
  
  getStandardDimensionNode in class IIOMetadata
- getStandardDocumentNode
```
protected IIOMetadataNode getStandardDocumentNode()
```
  Overrides:
  
  getStandardDocumentNode in class IIOMetadata
- getStandardTextNode
```
protected IIOMetadataNode getStandardTextNode()
```
  Overrides:
  
  getStandardTextNode in class IIOMetadata
- getStandardTransparencyNode
```
protected IIOMetadataNode getStandardTransparencyNode()
```
  Overrides:
  
  getStandardTransparencyNode in class IIOMetadata
- mergeTree
```
public void mergeTree(String formatName,
                      Node root)
               throws IIOInvalidTreeException
```
  Specified by:
  
  mergeTree in class IIOMetadata
  
  Throws:
  
  IIOInvalidTreeException
- reset
```
public void reset()
```
  Specified by:
  
  reset in class IIOMetadata

Class BMPMetadata

Field Summary

Fields inherited from class javax.imageio.metadata.IIOMetadata

Fields inherited from interface io.scif.media.imageioimpl.plugins.bmp.BMPConstants

Constructor Summary

Method Summary

Methods inherited from class javax.imageio.metadata.IIOMetadata

Methods inherited from class java.lang.Object

Field Detail

nativeMetadataFormatName

bmpVersion

width

height

bitsPerPixel

compression

imageSize

xPixelsPerMeter

yPixelsPerMeter

colorsUsed

colorsImportant

redMask

greenMask

blueMask

alphaMask

colorSpace

redX

redY

redZ

greenX

greenY

greenZ

blueX

blueY

blueZ

gammaRed

gammaGreen

gammaBlue

intent

palette

paletteSize

red

green

blue

comments

Constructor Detail

BMPMetadata

BMPMetadata

Method Detail

isReadOnly

clone

getAsTree

getStandardChromaNode

getStandardCompressionNode

getStandardDataNode

getStandardDimensionNode

getStandardDocumentNode

getStandardTextNode

getStandardTransparencyNode

mergeTree

reset