Source for javax.sound.sampled.Line

   1: /* An input or output 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 Line represents a single input or output audio line.
  43:  * @since 1.3
  44:  */
  45: public interface Line
  46: {
  47:   /**
  48:    * An object of this type holds information about a Line.
  49:    * @since 1.3
  50:    */
  51:   class Info
  52:   {
  53:     private Class klass;
  54: 
  55:     /**
  56:      * Create a new Info object.  The argument is the class of the line,
  57:      * for instance TargetDataLine.class.
  58:      * @param klass the class of the line
  59:      */
  60:     public Info(Class<?> klass)
  61:     {
  62:       this.klass = klass;
  63:     }
  64: 
  65:     /**
  66:      * Return the line's class.
  67:      */
  68:     public Class<?> getLineClass()
  69:     {
  70:       return klass;
  71:     }
  72: 
  73:     /**
  74:      * Return true if this Info object matches the given object.
  75:      * @param other the object to match
  76:      * @return true if they match, false otherwise
  77:      */
  78:     public boolean matches(Info other)
  79:     {
  80:       return klass.equals(other.klass);
  81:     }
  82: 
  83:     /**
  84:      * Return a description of this Info object.
  85:      */
  86:     public String toString()
  87:     {
  88:       return klass.toString();
  89:     }
  90:   }
  91: 
  92:   /**
  93:    * Add a listener which will be notified whenever this Line changes state.
  94:    * @param listener the listener to notify
  95:    */
  96:   void addLineListener(LineListener listener);
  97:   
  98:   /**
  99:    * Close this line.
 100:    */
 101:   void close();
 102: 
 103:   /**
 104:    * Return the control associated with this Line that matches the
 105:    * argument.
 106:    * @param what the type of the control to match
 107:    * @return the associated control
 108:    * @throws IllegalArgumentException if a control of this type is not
 109:    * available for this line
 110:    */
 111:   Control getControl(Control.Type what);
 112: 
 113:   /**
 114:    * Return an array of controls associated with this Line.  Note that
 115:    * this method will not return null -- if there are no controls, it
 116:    * will return a zero-length array.
 117:    */
 118:   Control[] getControls();
 119: 
 120:   /**
 121:    * Return the Info object associated with this Line.
 122:    */
 123:   Info getLineInfo();
 124: 
 125:   /**
 126:    * Return true if a Control matching the argument is available for this
 127:    * Line, false otherwise.
 128:    * @param what the type of the control to match
 129:    */
 130:   boolean isControlSupported(Control.Type what);
 131: 
 132:   /**
 133:    * Return true if this line is open, false otherwise.
 134:    */
 135:   boolean isOpen();
 136: 
 137:   /**
 138:    * Open this line.
 139:    * @throws LineUnavailableException if the line is unavailable for some
 140:    * reason
 141:    */
 142:   void open() throws LineUnavailableException;
 143: 
 144:   /**
 145:    * Remove the listener from this Line; after this call the listener will
 146:    * no longer be notified when this Line changes state.
 147:    * @param listener the listener to remove
 148:    */
 149:   void removeLineListener(LineListener listener);
 150: }