gomp-20050608-branch/libjava/classpath/javax/imageio/IIOParamController.java

   1 /* IIOParamController.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;
  40
  41 /**
  42  * An interface to set image parameters.  An IIOParamController may be
  43  * a GUI component, a database reader, command-line parser or any
  44  * other means of getting parameter settings.  For exampe, a dialog
  45  * box could implement IIOParamController to allow a user to adjust
  46  * JPEG compression levels.
  47  *
  48  * The activate method should always behave modally; it should only
  49  * return when the action has been either cancelled or completed.
  50  *
  51  * @author Michael Koch (konqueror@gmx.de)
  52  */
  53 public interface IIOParamController
  54 {
  55   /**
  56    * Activates the controller.  A return value of false should mean
  57    * that no changes were made to param.  A return value of true
  58    * should mean that the image is ready to be read or written.
  59    *
  60    * @param param the <code>IIOParam</code> to be modified
  61    *
  62    * @return true if the <code>IIOParam</code> has been modified,
  63    * false otherwise
  64    *
  65    * @exception IllegalArgumentException if param is null or is not an instance
  66    * of the correct class
  67    */
  68   boolean activate(IIOParam param);
  69 }