001/* Control over an attribute of a line 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 control provides the ability to affect some attribute of a line, 043 * for instance its volume. 044 * @since 1.3 045 */ 046public abstract class Control 047{ 048 /** 049 * This describes a single control. 050 * @since 1.3 051 */ 052 public static class Type 053 { 054 private String name; 055 056 /** 057 * Create a new Type given its name. 058 * @param name the name of the type 059 */ 060 protected Type(String name) 061 { 062 this.name = name; 063 } 064 065 public final boolean equals(Object o) 066 { 067 return super.equals(o); 068 } 069 070 public final int hashCode() 071 { 072 return super.hashCode(); 073 } 074 075 /** 076 * Return the name of this Type. 077 */ 078 public final String toString() 079 { 080 return name; 081 } 082 } 083 084 private Type type; 085 086 /** 087 * Create a new Control given its Type. 088 * @param type the type 089 */ 090 protected Control(Type type) 091 { 092 this.type = type; 093 } 094 095 /** 096 * Return the Type of this Control. 097 */ 098 public Type getType() 099 { 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}