001    /* 
002       Copyright (C) 2005 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package javax.sound.sampled;
040    
041    /**
042     * An EnumControl is a Control which can take one of a specified set of
043     * values. 
044     * @since 1.3
045     */
046    public abstract class EnumControl extends Control
047    {
048      /**
049       * This Type describes an EnumControl.
050       * @since 1.3
051       */
052      public static class Type extends Control.Type
053      {
054        /** This describes an enum control used for reverb.  */
055        public static final Type REVERB = new Type("Reverb");
056    
057        /**
058         * Create a new Type given its name.
059         * @param name the name of the type
060         */
061        protected Type(String name)
062        {
063          super(name);
064        }
065      }
066    
067      private Object[] values;
068      private Object value;
069    
070      /**
071       * Create a new enumerated control given its Type, the range of valid
072       * values, and its initial value.
073       * @param type the type
074       * @param values the valid values
075       * @param val the initial value
076       */
077      protected EnumControl(Type type, Object[] values, Object val)
078      {
079        super(type);
080        // FIXME: error checking: values.length>0, val in values... ?
081        // FIXME: clone here?
082        this.values = values;
083        this.value = val;
084      }
085    
086      /**
087       * Return the current value of this control.
088       */
089      public Object getValue()
090      {
091        return value;
092      }
093    
094      /**
095       * Return the valid values for this control.
096       */
097      public Object[] getValues()
098      {
099        // 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    }