GIFStreamMetadata (SCIFIO Javadocs 0-SNAPSHOT API)

java.lang.Object
- javax.imageio.metadata.IIOMetadata
- - io.scif.media.imageioimpl.plugins.gif.GIFStreamMetadata

public class GIFStreamMetadata
extends IIOMetadata

Version:: 0.5

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`backgroundColorIndex`
`int`	`colorResolution`
`static String[]`	`colorTableSizes`
`byte[]`	`globalColorTable`
`int`	`logicalScreenHeight`
`int`	`logicalScreenWidth`
`int`	`pixelAspectRatio`
`boolean`	`sortFlag`
`String`	`version`
`static String[]`	`versionStrings`

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`GIFStreamMetadata()`
`protected`	`GIFStreamMetadata(boolean standardMetadataFormatSupported, String nativeMetadataFormatName, String nativeMetadataFormatClassName, String[] extraMetadataFormatNames, String[] extraMetadataFormatClassNames)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static void`	`fatal(Node node, String reason)`
`Node`	`getAsTree(String formatName)`
`protected static String`	`getAttribute(Node node, String name)`
`protected static String`	`getAttribute(Node node, String name, String defaultValue, boolean required)`
`protected static boolean`	`getBooleanAttribute(Node node, String name)`
`protected static boolean`	`getBooleanAttribute(Node node, String name, boolean defaultValue, boolean required)`
`protected byte[]`	`getColorTable(Node colorTableNode, String entryNodeName, boolean lengthExpected, int expectedLength)`
`protected static int`	`getEnumeratedAttribute(Node node, String name, String[] legalNames)`
`protected static int`	`getEnumeratedAttribute(Node node, String name, String[] legalNames, int defaultValue, boolean required)`
`protected static float`	`getFloatAttribute(Node node, String name)`
`protected static float`	`getFloatAttribute(Node node, String name, float defaultValue, boolean required)`
`protected static int`	`getIntAttribute(Node node, String name, boolean bounded, int min, int max)`
`protected static int`	`getIntAttribute(Node node, String name, int defaultValue, boolean required, boolean bounded, int min, int max)`
`IIOMetadataNode`	`getStandardChromaNode()`
`IIOMetadataNode`	`getStandardCompressionNode()`
`IIOMetadataNode`	`getStandardDataNode()`
`IIOMetadataNode`	`getStandardDimensionNode()`
`IIOMetadataNode`	`getStandardDocumentNode()`
`IIOMetadataNode`	`getStandardTextNode()`
`IIOMetadataNode`	`getStandardTransparencyNode()`
`protected static String`	`getStringAttribute(Node node, String name, String defaultValue, boolean required, String[] range)`
`boolean`	`isReadOnly()`
`protected void`	`mergeNativeTree(Node root)`
`protected void`	`mergeStandardTree(Node root)`
`void`	`mergeTree(String formatName, Node root)`
`void`	`reset()`
`void`	`setFromTree(String formatName, Node root)`

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

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

Field Detail

versionStrings

public static final String[] versionStrings

version
```
public String version
```

logicalScreenWidth
```
public int logicalScreenWidth
```

logicalScreenHeight
```
public int logicalScreenHeight
```

colorResolution
```
public int colorResolution
```

pixelAspectRatio
```
public int pixelAspectRatio
```

backgroundColorIndex
```
public int backgroundColorIndex
```

sortFlag
```
public boolean sortFlag
```

colorTableSizes

public static final String[] colorTableSizes

globalColorTable
```
public byte[] globalColorTable
```

Constructor Detail

GIFStreamMetadata

protected GIFStreamMetadata(boolean standardMetadataFormatSupported,
                            String nativeMetadataFormatName,
                            String nativeMetadataFormatClassName,
                            String[] extraMetadataFormatNames,
                            String[] extraMetadataFormatClassNames)

GIFStreamMetadata
```
public GIFStreamMetadata()
```

Method Detail

isReadOnly
```
public boolean isReadOnly()
```
Specified by:

isReadOnly in class IIOMetadata

getAsTree
```
public Node getAsTree(String formatName)
```
Specified by:

getAsTree in class IIOMetadata

getStandardChromaNode
```
public IIOMetadataNode getStandardChromaNode()
```
Overrides:

getStandardChromaNode in class IIOMetadata

getStandardCompressionNode
```
public IIOMetadataNode getStandardCompressionNode()
```
Overrides:

getStandardCompressionNode in class IIOMetadata

getStandardDataNode
```
public IIOMetadataNode getStandardDataNode()
```
Overrides:

getStandardDataNode in class IIOMetadata

getStandardDimensionNode
```
public IIOMetadataNode getStandardDimensionNode()
```
Overrides:

getStandardDimensionNode in class IIOMetadata

getStandardDocumentNode
```
public IIOMetadataNode getStandardDocumentNode()
```
Overrides:

getStandardDocumentNode in class IIOMetadata

getStandardTextNode
```
public IIOMetadataNode getStandardTextNode()
```
Overrides:

getStandardTextNode in class IIOMetadata

getStandardTransparencyNode
```
public IIOMetadataNode getStandardTransparencyNode()
```
Overrides:

getStandardTransparencyNode in class IIOMetadata

setFromTree

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

Overrides:: setFromTree in class IIOMetadata
Throws:: IIOInvalidTreeException

mergeNativeTree

protected void mergeNativeTree(Node root)
                        throws IIOInvalidTreeException

Throws:: IIOInvalidTreeException

mergeStandardTree

protected void mergeStandardTree(Node root)
                          throws IIOInvalidTreeException

Throws:: IIOInvalidTreeException

reset
```
public void reset()
```
Specified by:

reset in class IIOMetadata

fatal

protected static void fatal(Node node,
                            String reason)
                     throws IIOInvalidTreeException

Throws:: IIOInvalidTreeException

getStringAttribute

protected static String getStringAttribute(Node node,
                                           String name,
                                           String defaultValue,
                                           boolean required,
                                           String[] range)
                                    throws IIOInvalidTreeException

Throws:: IIOInvalidTreeException

getIntAttribute

protected static int getIntAttribute(Node node,
                                     String name,
                                     int defaultValue,
                                     boolean required,
                                     boolean bounded,
                                     int min,
                                     int max)
                              throws IIOInvalidTreeException

Throws:: IIOInvalidTreeException

getFloatAttribute

protected static float getFloatAttribute(Node node,
                                         String name,
                                         float defaultValue,
                                         boolean required)
                                  throws IIOInvalidTreeException

Throws:: IIOInvalidTreeException

getIntAttribute

protected static int getIntAttribute(Node node,
                                     String name,
                                     boolean bounded,
                                     int min,
                                     int max)
                              throws IIOInvalidTreeException

Throws:: IIOInvalidTreeException

getFloatAttribute

protected static float getFloatAttribute(Node node,
                                         String name)
                                  throws IIOInvalidTreeException

Throws:: IIOInvalidTreeException

getBooleanAttribute

protected static boolean getBooleanAttribute(Node node,
                                             String name,
                                             boolean defaultValue,
                                             boolean required)
                                      throws IIOInvalidTreeException

Throws:: IIOInvalidTreeException

getBooleanAttribute

protected static boolean getBooleanAttribute(Node node,
                                             String name)
                                      throws IIOInvalidTreeException

Throws:: IIOInvalidTreeException

getEnumeratedAttribute

protected static int getEnumeratedAttribute(Node node,
                                            String name,
                                            String[] legalNames,
                                            int defaultValue,
                                            boolean required)
                                     throws IIOInvalidTreeException

Throws:: IIOInvalidTreeException

getEnumeratedAttribute

protected static int getEnumeratedAttribute(Node node,
                                            String name,
                                            String[] legalNames)
                                     throws IIOInvalidTreeException

Throws:: IIOInvalidTreeException

getAttribute

protected static String getAttribute(Node node,
                                     String name,
                                     String defaultValue,
                                     boolean required)
                              throws IIOInvalidTreeException

Throws:: IIOInvalidTreeException

getAttribute

protected static String getAttribute(Node node,
                                     String name)
                              throws IIOInvalidTreeException

Throws:: IIOInvalidTreeException

mergeTree

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

Specified by:: mergeTree in class IIOMetadata
Throws:: IIOInvalidTreeException

getColorTable

protected byte[] getColorTable(Node colorTableNode,
                               String entryNodeName,
                               boolean lengthExpected,
                               int expectedLength)
                        throws IIOInvalidTreeException

Throws:: IIOInvalidTreeException

Class GIFStreamMetadata

Field Summary

Fields inherited from class javax.imageio.metadata.IIOMetadata

Constructor Summary

Method Summary

Methods inherited from class javax.imageio.metadata.IIOMetadata

Methods inherited from class java.lang.Object

Field Detail

versionStrings

version

logicalScreenWidth

logicalScreenHeight

colorResolution

pixelAspectRatio

backgroundColorIndex

sortFlag

colorTableSizes

globalColorTable

Constructor Detail

GIFStreamMetadata

GIFStreamMetadata

Method Detail

isReadOnly

getAsTree

getStandardChromaNode

getStandardCompressionNode

getStandardDataNode

getStandardDimensionNode

getStandardDocumentNode

getStandardTextNode

getStandardTransparencyNode

setFromTree

mergeNativeTree

mergeStandardTree

reset

fatal

getStringAttribute

getIntAttribute

getFloatAttribute

getIntAttribute

getFloatAttribute

getBooleanAttribute

getBooleanAttribute

getEnumeratedAttribute

getEnumeratedAttribute

getAttribute

getAttribute

mergeTree

getColorTable