libjava/classpath/javax/imageio/metadata/IIOMetadataFormat.java

   1 /* IIOMetadataFormat.java --
   2    Copyright (C) 2004  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.imageio.metadata;
  40
  41 import java.util.Locale;
  42
  43 import javax.imageio.ImageTypeSpecifier;
  44
  45 /**
  46  * @author Michael Koch (konqueror@gmx.de)
  47  */
  48 public interface IIOMetadataFormat
  49 {
  50   int CHILD_POLICY_ALL = 1;
  51   int CHILD_POLICY_CHOICE = 3;
  52   int CHILD_POLICY_EMPTY = 0;
  53   int CHILD_POLICY_MAX = 5;
  54   int CHILD_POLICY_REPEAT = 5;
  55   int CHILD_POLICY_SEQUENCE = 4;
  56   int CHILD_POLICY_SOME = 2;
  57   int DATATYPE_BOOLEAN = 1;
  58   int DATATYPE_DOUBLE = 4;
  59   int DATATYPE_FLOAT = 3;
  60   int DATATYPE_INTEGER = 2;
  61   int DATATYPE_STRING = 0;
  62   int VALUE_ARBITRARY = 1;
  63   int VALUE_ENUMERATION = 16;
  64   int VALUE_LIST = 32;
  65   int VALUE_NONE = 0;
  66   int VALUE_RANGE = 2;
  67   int VALUE_RANGE_MAX_INCLUSIVE = 10;
  68   int VALUE_RANGE_MAX_INCLUSIVE_MASK = 8;
  69   int VALUE_RANGE_MIN_INCLUSIVE = 6;
  70   int VALUE_RANGE_MIN_INCLUSIVE_MASK = 4;
  71   int VALUE_RANGE_MIN_MAX_INCLUSIVE = 14;
  72
  73   boolean canNodeAppear (String elementName, ImageTypeSpecifier imageType);
  74
  75   int getAttributeDataType (String elementName, String attrName);
  76
  77   String getAttributeDefaultValue (String elementName, String attrName);
  78
  79   String getAttributeDescription (String elementName, String attrName, Locale locale);
  80
  81   String[] getAttributeEnumerations (String elementName, String attrName);
  82
  83   int getAttributeListMaxLength (String elementName, String attrName);
  84
  85   int getAttributeListMinLength (String elementName, String attrName);
  86
  87   String getAttributeMaxValue (String elementName, String attrName);
  88
  89   String getAttributeMinValue (String elementName, String attrName);
  90
  91   String[] getAttributeNames (String elementName);
  92
  93   int getAttributeValueType (String elementName, String attrName);
  94
  95   String[] getChildNames (String elementName);
  96
  97   int getChildPolicy (String elementName);
  98
  99   String getElementDescription (String elementName, Locale locale);
 100
 101   int getElementMaxChildren (String elementName);
 102
 103   int getElementMinChildren (String elementName);
 104
 105   int getObjectArrayMaxLength (String elementName);
 106
 107   int getObjectArrayMinLength (String elementName);
 108
 109   Class<?> getObjectClass (String elementName);
 110
 111   Object getObjectDefaultValue (String elementName);
 112
 113   Object[] getObjectEnumerations (String elementName);
 114
 115   Comparable<?> getObjectMaxValue (String elementName);
 116
 117   Comparable<?> getObjectMinValue (String elementName);
 118
 119   int getObjectValueType (String elementName);
 120
 121   String getRootName();
 122
 123   boolean isAttributeRequired (String elementName, String attrName);
 124 }