Source for javax.imageio.ImageTranscoder

   1: /* ImageTranscoder.java -- Image metadata transcoder.
   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;
  40: 
  41: import javax.imageio.metadata.IIOMetadata;
  42: 
  43: /**
  44:  * An ImageTranscoder translates IIOMetadata objects provided by an
  45:  * ImageReader into corresponding IIOMetadata objects that can be
  46:  * understood by a given ImageWriter.
  47:  *
  48:  * Usually an ImageWriter will implement ImageTranscoder directly in
  49:  * which case the conversion methods will return IIOMetadata objects
  50:  * appropriate for this ImageWriter.
  51:  *
  52:  * Independent transcoders are also allowed; they must have knowledge
  53:  * of both the source IIOMetadata provided by the reader and the
  54:  * returned IIOMetadata expected by the writer.
  55:  *
  56:  * @author Michael Koch (konqueror@gmx.de)
  57:  */
  58: public interface ImageTranscoder
  59: {
  60:   /**
  61:    * Converts IIOMetadata from an input reader format, returning an
  62:    * IIOMetadata suitable for use by an image writer.
  63:    *
  64:    * The ImageTypeSpecifier specifies the destination image type.
  65:    *
  66:    * An optional ImageWriteParam argument is available in case the
  67:    * image writing parameters affect the metadata conversion.
  68:    *
  69:    * @param inData the metadata coming from an image reader
  70:    * @param imageType the output image type of the writer
  71:    * @param param the image writing parameters or null
  72:    *
  73:    * @return the converted metadata that should be used by the image
  74:    * writer, or null if this ImageTranscoder has no knowledge of the
  75:    * input metadata
  76:    *
  77:    * @exception IllegalArgumentException if either inData or imageType
  78:    * is null
  79:    */
  80:   IIOMetadata convertImageMetadata(IIOMetadata inData,
  81:                            ImageTypeSpecifier imageType,
  82:                    ImageWriteParam param);
  83: 
  84:   /**
  85:    * Converts IIOMetadata from an input stream format, returning an
  86:    * IIOMetadata suitable for use by an image writer.
  87:    *
  88:    * An optional ImageWriteParam argument is available in case the
  89:    * image writing parameters affect the metadata conversion.
  90:    *
  91:    * @param inData the metadata coming from an input image stream
  92:    * @param param the image writing parameters or null
  93:    *
  94:    * @return the converted metadata that should be used by the image
  95:    * writer, or null if this ImageTranscoder has no knowledge of the
  96:    * input metadata
  97:    *
  98:    * @exception IllegalArgumentException if inData is null
  99:    */
 100:   IIOMetadata convertStreamMetadata(IIOMetadata inData,
 101:                     ImageWriteParam param);
 102: }