Source for javax.sound.sampled.EnumControl

   1: /* 
   2:    Copyright (C) 2005 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.sound.sampled;
  40: 
  41: /**
  42:  * An EnumControl is a Control which can take one of a specified set of
  43:  * values. 
  44:  * @since 1.3
  45:  */
  46: public abstract class EnumControl extends Control
  47: {
  48:   /**
  49:    * This Type describes an EnumControl.
  50:    * @since 1.3
  51:    */
  52:   public static class Type extends Control.Type
  53:   {
  54:     /** This describes an enum control used for reverb.  */
  55:     public static final Type REVERB = new Type("Reverb");
  56: 
  57:     /**
  58:      * Create a new Type given its name.
  59:      * @param name the name of the type
  60:      */
  61:     protected Type(String name)
  62:     {
  63:       super(name);
  64:     }
  65:   }
  66: 
  67:   private Object[] values;
  68:   private Object value;
  69: 
  70:   /**
  71:    * Create a new enumerated control given its Type, the range of valid
  72:    * values, and its initial value.
  73:    * @param type the type
  74:    * @param values the valid values
  75:    * @param val the initial value
  76:    */
  77:   protected EnumControl(Type type, Object[] values, Object val)
  78:   {
  79:     super(type);
  80:     // FIXME: error checking: values.length>0, val in values... ?
  81:     // FIXME: clone here?
  82:     this.values = values;
  83:     this.value = val;
  84:   }
  85: 
  86:   /**
  87:    * Return the current value of this control.
  88:    */
  89:   public Object getValue()
  90:   {
  91:     return value;
  92:   }
  93: 
  94:   /**
  95:    * Return the valid values for this control.
  96:    */
  97:   public Object[] getValues()
  98:   {
  99:     // FIXME: clone here?
 100:     return values;
 101:   }
 102: 
 103:   /**
 104:    * Set the value of this control.  If the indicated value is not among
 105:    * the valid values, this method will throw an IllegalArgumentException.
 106:    * @param value the new value
 107:    * @throws IllegalArgumentException if the new value is invalid
 108:    */
 109:   public void setValue(Object value)
 110:   {
 111:     for (int i = 0; i < values.length; ++i)
 112:       {
 113:     if (! values[i].equals(value))
 114:       throw new IllegalArgumentException("value not supported");
 115:       }
 116:     this.value = value;
 117:   }
 118: 
 119:   /**
 120:    * Return a string describing this control.
 121:    */
 122:   public String toString()
 123:   {
 124:     return super.toString() + ": " + value;
 125:   }
 126: }