Source for javax.sound.sampled.Port

   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:  * A Port is a Line which represents an audio device, for instance
  43:  * a microphone.
  44:  * 
  45:  * @since 1.3
  46:  */
  47: public interface Port extends Line
  48: {
  49:   /**
  50:    * This describes a single port.
  51:    * @since 1.3
  52:    */
  53:   class Info extends Line.Info
  54:   {
  55:     // FIXME names?
  56: 
  57:     /** A CD player.  */
  58:     public static final Info COMPACT_DISC = new Info(Port.class,
  59:                              "Compact Disc",
  60:                              true);
  61: 
  62:     /** Headphones.  */
  63:     public static final Info HEADPHONE = new Info(Port.class, "Headphone",
  64:                           false);
  65: 
  66:     /** Generic input line.  */
  67:     public static final Info LINE_IN = new Info(Port.class, "Line in",
  68:                         true);
  69: 
  70:     /** Generic output line.  */
  71:     public static final Info LINE_OUT = new Info(Port.class, "Line out",
  72:                          false);
  73: 
  74:     /** A microphone.  */
  75:     public static final Info MICROPHONE = new Info(Port.class, "Microphone",
  76:                            true);
  77: 
  78:     /** A speaker.  */
  79:     public static final Info SPEAKER = new Info(Port.class, "Speaker",
  80:                         false);
  81: 
  82:     private String name;
  83:     private boolean isSource;
  84: 
  85:     /**
  86:      * Create a new Info object, given the line's class, the name,
  87:      * and an argument indicating whether this is an input or an output.
  88:      * @param klass the class of the line
  89:      * @param name the name of the line
  90:      * @param isSource true if this is an input source
  91:      */
  92:     public Info(Class<?> klass, String name, boolean isSource)
  93:     {
  94:       super(klass);
  95:       this.name = name;
  96:       this.isSource = isSource;
  97:     }
  98: 
  99:     public final boolean equals(Object o)
 100:     {
 101:       return super.equals(o);
 102:     }
 103: 
 104:     public final int hashCode()
 105:     {
 106:       return super.hashCode();
 107:     }
 108: 
 109:     /**
 110:      * Return the name of this object.
 111:      */
 112:     public String getName()
 113:     {
 114:       return name;
 115:     }
 116: 
 117:     /**
 118:      * Return true if this describes an input line.
 119:      */
 120:     public boolean isSource()
 121:     {
 122:       return isSource;
 123:     }
 124: 
 125:     public boolean matches(Line.Info other)
 126:     {
 127:       return super.matches(other) && equals(other);
 128:     }
 129: 
 130:     public final String toString()
 131:     {
 132:       return super.toString() + "; name=" + name + "; isSource=" + isSource;
 133:     }
 134:   }
 135: }