001/* 002 Copyright (C) 2005 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package javax.sound.sampled; 040 041/** 042 * A Port is a Line which represents an audio device, for instance 043 * a microphone. 044 * 045 * @since 1.3 046 */ 047public interface Port extends Line 048{ 049 /** 050 * This describes a single port. 051 * @since 1.3 052 */ 053 class Info extends Line.Info 054 { 055 // FIXME names? 056 057 /** A CD player. */ 058 public static final Info COMPACT_DISC = new Info(Port.class, 059 "Compact Disc", 060 true); 061 062 /** Headphones. */ 063 public static final Info HEADPHONE = new Info(Port.class, "Headphone", 064 false); 065 066 /** Generic input line. */ 067 public static final Info LINE_IN = new Info(Port.class, "Line in", 068 true); 069 070 /** Generic output line. */ 071 public static final Info LINE_OUT = new Info(Port.class, "Line out", 072 false); 073 074 /** A microphone. */ 075 public static final Info MICROPHONE = new Info(Port.class, "Microphone", 076 true); 077 078 /** A speaker. */ 079 public static final Info SPEAKER = new Info(Port.class, "Speaker", 080 false); 081 082 private String name; 083 private boolean isSource; 084 085 /** 086 * Create a new Info object, given the line's class, the name, 087 * and an argument indicating whether this is an input or an output. 088 * @param klass the class of the line 089 * @param name the name of the line 090 * @param isSource true if this is an input source 091 */ 092 public Info(Class<?> klass, String name, boolean isSource) 093 { 094 super(klass); 095 this.name = name; 096 this.isSource = isSource; 097 } 098 099 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}