Source for javax.sound.sampled.Control

   1: /* Control over an attribute of a line
   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:  * A control provides the ability to affect some attribute of a line,
  43:  * for instance its volume.
  44:  * @since 1.3
  45:  */
  46: public abstract class Control
  47: {
  48:   /**
  49:    * This describes a single control.
  50:    * @since 1.3
  51:    */
  52:   public static class Type
  53:   {
  54:     private String name;
  55: 
  56:     /**
  57:      * Create a new Type given its name.
  58:      * @param name the name of the type
  59:      */
  60:     protected Type(String name)
  61:     {
  62:       this.name = name;
  63:     }
  64: 
  65:     public final boolean equals(Object o)
  66:     {
  67:       return super.equals(o);
  68:     }
  69: 
  70:     public final int hashCode()
  71:     {
  72:       return super.hashCode();
  73:     }
  74: 
  75:     /**
  76:      * Return the name of this Type.
  77:      */
  78:     public final String toString()
  79:     {
  80:       return name;
  81:     }
  82:   }
  83: 
  84:   private Type type;
  85: 
  86:   /**
  87:    * Create a new Control given its Type.
  88:    * @param type the type
  89:    */
  90:   protected Control(Type type)
  91:   {
  92:     this.type = type;
  93:   }
  94: 
  95:   /**
  96:    * Return the Type of this Control.
  97:    */
  98:   public Type getType()
  99:   {
 100:     return type;
 101:   }
 102: 
 103:   /**
 104:    * Return a String descrsibing this control.  In particular the
 105:    * value will include the name of the associated Type.
 106:    */
 107:   public String toString()
 108:   {
 109:     return type.toString();
 110:   }
 111: }