001/* IIOMetadataFormat.java --
002   Copyright (C) 2004  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.imageio.metadata;
040
041import java.util.Locale;
042
043import javax.imageio.ImageTypeSpecifier;
044
045/**
046 * @author Michael Koch (konqueror@gmx.de)
047 */
048public interface IIOMetadataFormat
049{
050  int CHILD_POLICY_ALL = 1;
051  int CHILD_POLICY_CHOICE = 3;
052  int CHILD_POLICY_EMPTY = 0;
053  int CHILD_POLICY_MAX = 5;
054  int CHILD_POLICY_REPEAT = 5;
055  int CHILD_POLICY_SEQUENCE = 4;
056  int CHILD_POLICY_SOME = 2;
057  int DATATYPE_BOOLEAN = 1;
058  int DATATYPE_DOUBLE = 4;
059  int DATATYPE_FLOAT = 3;
060  int DATATYPE_INTEGER = 2;
061  int DATATYPE_STRING = 0;
062  int VALUE_ARBITRARY = 1;
063  int VALUE_ENUMERATION = 16;
064  int VALUE_LIST = 32;
065  int VALUE_NONE = 0;
066  int VALUE_RANGE = 2;
067  int VALUE_RANGE_MAX_INCLUSIVE = 10;
068  int VALUE_RANGE_MAX_INCLUSIVE_MASK = 8;
069  int VALUE_RANGE_MIN_INCLUSIVE = 6;
070  int VALUE_RANGE_MIN_INCLUSIVE_MASK = 4;
071  int VALUE_RANGE_MIN_MAX_INCLUSIVE = 14;
072
073  boolean canNodeAppear (String elementName, ImageTypeSpecifier imageType);
074
075  int getAttributeDataType (String elementName, String attrName);
076
077  String getAttributeDefaultValue (String elementName, String attrName);
078
079  String getAttributeDescription (String elementName, String attrName, Locale locale);
080
081  String[] getAttributeEnumerations (String elementName, String attrName);
082
083  int getAttributeListMaxLength (String elementName, String attrName);
084
085  int getAttributeListMinLength (String elementName, String attrName);
086
087  String getAttributeMaxValue (String elementName, String attrName);
088
089  String getAttributeMinValue (String elementName, String attrName);
090
091  String[] getAttributeNames (String elementName);
092
093  int getAttributeValueType (String elementName, String attrName);
094
095  String[] getChildNames (String elementName);
096
097  int getChildPolicy (String elementName);
098
099  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}