libjava/classpath/javax/sound/sampled/Line.java

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