Package com.github.jaiimageio.impl.plugins.gif

Class GIFMetadata

  • Direct Known Subclasses:
    GIFImageMetadata, GIFStreamMetadata
    abstract class GIFMetadata
extends javax.imageio.metadata.IIOMetadata
    Class which adds utility DOM element attribute access methods to IIOMetadata for subclass use.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) static int UNDEFINED_INTEGER_VALUE
      Represents an undefined value of integer attributes.

      • Fields inherited from class javax.imageio.metadata.IIOMetadata

        controller, defaultController, extraMetadataFormatClassNames, extraMetadataFormatNames, nativeMetadataFormatClassName, nativeMetadataFormatName, standardFormatSupported

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected GIFMetadata​(boolean standardMetadataFormatSupported, java.lang.String nativeMetadataFormatName, java.lang.String nativeMetadataFormatClassName, java.lang.String[] extraMetadataFormatNames, java.lang.String[] extraMetadataFormatClassNames)  

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected static void fatal​(org.w3c.dom.Node node, java.lang.String reason)  
      protected static java.lang.String getAttribute​(org.w3c.dom.Node node, java.lang.String name)  
      protected static java.lang.String getAttribute​(org.w3c.dom.Node node, java.lang.String name, java.lang.String defaultValue, boolean required)  
      protected static boolean getBooleanAttribute​(org.w3c.dom.Node node, java.lang.String name)  
      protected static boolean getBooleanAttribute​(org.w3c.dom.Node node, java.lang.String name, boolean defaultValue, boolean required)  
      protected byte[] getColorTable​(org.w3c.dom.Node colorTableNode, java.lang.String entryNodeName, boolean lengthExpected, int expectedLength)  
      protected static int getEnumeratedAttribute​(org.w3c.dom.Node node, java.lang.String name, java.lang.String[] legalNames)  
      protected static int getEnumeratedAttribute​(org.w3c.dom.Node node, java.lang.String name, java.lang.String[] legalNames, int defaultValue, boolean required)  
      protected static float getFloatAttribute​(org.w3c.dom.Node node, java.lang.String name)  
      protected static float getFloatAttribute​(org.w3c.dom.Node node, java.lang.String name, float defaultValue, boolean required)  
      protected static int getIntAttribute​(org.w3c.dom.Node node, java.lang.String name, boolean bounded, int min, int max)  
      protected static int getIntAttribute​(org.w3c.dom.Node node, java.lang.String name, int defaultValue, boolean required, boolean bounded, int min, int max)  
      protected static java.lang.String getStringAttribute​(org.w3c.dom.Node node, java.lang.String name, java.lang.String defaultValue, boolean required, java.lang.String[] range)  
      protected abstract void mergeNativeTree​(org.w3c.dom.Node root)  
      protected abstract void mergeStandardTree​(org.w3c.dom.Node root)  
      void mergeTree​(java.lang.String formatName, org.w3c.dom.Node root)  

      • Methods inherited from class javax.imageio.metadata.IIOMetadata

        activateController, getAsTree, getController, getDefaultController, getExtraMetadataFormatNames, getMetadataFormat, getMetadataFormatNames, getNativeMetadataFormatName, getStandardChromaNode, getStandardCompressionNode, getStandardDataNode, getStandardDimensionNode, getStandardDocumentNode, getStandardTextNode, getStandardTileNode, getStandardTransparencyNode, getStandardTree, hasController, isReadOnly, isStandardMetadataFormatSupported, reset, setController, setFromTree

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • UNDEFINED_INTEGER_VALUE

        static final int UNDEFINED_INTEGER_VALUE
        Represents an undefined value of integer attributes.
        See Also:
        Constant Field Values

    • Constructor Detail

      • GIFMetadata

        protected GIFMetadata​(boolean standardMetadataFormatSupported,
                      java.lang.String nativeMetadataFormatName,
                      java.lang.String nativeMetadataFormatClassName,
                      java.lang.String[] extraMetadataFormatNames,
                      java.lang.String[] extraMetadataFormatClassNames)

    • Method Detail

      • fatal

        protected static void fatal​(org.w3c.dom.Node node,
                            java.lang.String reason)
                     throws javax.imageio.metadata.IIOInvalidTreeException
        Throws:
        javax.imageio.metadata.IIOInvalidTreeException

      • getStringAttribute

        protected static java.lang.String getStringAttribute​(org.w3c.dom.Node node,
                                                     java.lang.String name,
                                                     java.lang.String defaultValue,
                                                     boolean required,
                                                     java.lang.String[] range)
                                              throws javax.imageio.metadata.IIOInvalidTreeException
        Throws:
        javax.imageio.metadata.IIOInvalidTreeException

      • getIntAttribute

        protected static int getIntAttribute​(org.w3c.dom.Node node,
                                     java.lang.String name,
                                     int defaultValue,
                                     boolean required,
                                     boolean bounded,
                                     int min,
                                     int max)
                              throws javax.imageio.metadata.IIOInvalidTreeException
        Throws:
        javax.imageio.metadata.IIOInvalidTreeException

      • getFloatAttribute

        protected static float getFloatAttribute​(org.w3c.dom.Node node,
                                         java.lang.String name,
                                         float defaultValue,
                                         boolean required)
                                  throws javax.imageio.metadata.IIOInvalidTreeException
        Throws:
        javax.imageio.metadata.IIOInvalidTreeException

      • getIntAttribute

        protected static int getIntAttribute​(org.w3c.dom.Node node,
                                     java.lang.String name,
                                     boolean bounded,
                                     int min,
                                     int max)
                              throws javax.imageio.metadata.IIOInvalidTreeException
        Throws:
        javax.imageio.metadata.IIOInvalidTreeException

      • getFloatAttribute

        protected static float getFloatAttribute​(org.w3c.dom.Node node,
                                         java.lang.String name)
                                  throws javax.imageio.metadata.IIOInvalidTreeException
        Throws:
        javax.imageio.metadata.IIOInvalidTreeException

      • getBooleanAttribute

        protected static boolean getBooleanAttribute​(org.w3c.dom.Node node,
                                             java.lang.String name,
                                             boolean defaultValue,
                                             boolean required)
                                      throws javax.imageio.metadata.IIOInvalidTreeException
        Throws:
        javax.imageio.metadata.IIOInvalidTreeException

      • getBooleanAttribute

        protected static boolean getBooleanAttribute​(org.w3c.dom.Node node,
                                             java.lang.String name)
                                      throws javax.imageio.metadata.IIOInvalidTreeException
        Throws:
        javax.imageio.metadata.IIOInvalidTreeException

      • getEnumeratedAttribute

        protected static int getEnumeratedAttribute​(org.w3c.dom.Node node,
                                            java.lang.String name,
                                            java.lang.String[] legalNames,
                                            int defaultValue,
                                            boolean required)
                                     throws javax.imageio.metadata.IIOInvalidTreeException
        Throws:
        javax.imageio.metadata.IIOInvalidTreeException

      • getEnumeratedAttribute

        protected static int getEnumeratedAttribute​(org.w3c.dom.Node node,
                                            java.lang.String name,
                                            java.lang.String[] legalNames)
                                     throws javax.imageio.metadata.IIOInvalidTreeException
        Throws:
        javax.imageio.metadata.IIOInvalidTreeException

      • getAttribute

        protected static java.lang.String getAttribute​(org.w3c.dom.Node node,
                                               java.lang.String name,
                                               java.lang.String defaultValue,
                                               boolean required)
                                        throws javax.imageio.metadata.IIOInvalidTreeException
        Throws:
        javax.imageio.metadata.IIOInvalidTreeException

      • getAttribute

        protected static java.lang.String getAttribute​(org.w3c.dom.Node node,
                                               java.lang.String name)
                                        throws javax.imageio.metadata.IIOInvalidTreeException
        Throws:
        javax.imageio.metadata.IIOInvalidTreeException

      • mergeTree

        public void mergeTree​(java.lang.String formatName,
                      org.w3c.dom.Node root)
               throws javax.imageio.metadata.IIOInvalidTreeException
        Specified by:
        mergeTree in class javax.imageio.metadata.IIOMetadata
        Throws:
        javax.imageio.metadata.IIOInvalidTreeException

      • getColorTable

        protected byte[] getColorTable​(org.w3c.dom.Node colorTableNode,
                               java.lang.String entryNodeName,
                               boolean lengthExpected,
                               int expectedLength)
                        throws javax.imageio.metadata.IIOInvalidTreeException
        Throws:
        javax.imageio.metadata.IIOInvalidTreeException

      • mergeNativeTree

        protected abstract void mergeNativeTree​(org.w3c.dom.Node root)
                                 throws javax.imageio.metadata.IIOInvalidTreeException
        Throws:
        javax.imageio.metadata.IIOInvalidTreeException

      • mergeStandardTree

        protected abstract void mergeStandardTree​(org.w3c.dom.Node root)
                                   throws javax.imageio.metadata.IIOInvalidTreeException
        Throws:
        javax.imageio.metadata.IIOInvalidTreeException