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 BooleanControl is a Control which has two states. 043 * @since 1.3 044 */ 045public abstract class BooleanControl extends Control 046{ 047 /** 048 * A Type specialized to represent a boolean control. 049 * @since 1.3 050 */ 051 public static class Type extends Control.Type 052 { 053 // FIXME: correct constructions? 054 055 /** 056 * A control for applying reverb. 057 */ 058 public final static Type APPLY_REVERB = new Type("Apply reverb"); 059 060 /** 061 * A control for muting. 062 */ 063 public final static Type MUTE = new Type("Mute"); 064 065 /** 066 * Create a new Type given its name. 067 * @param name the name of the type 068 */ 069 protected Type(String name) 070 { 071 super(name); 072 } 073 } 074 075 private boolean value; 076 private String trueLabel; 077 private String falseLabel; 078 079 /** 080 * Create a new boolean control, with the indicated Type and initial 081 * value. The description strings will default to "true" and "false". 082 * @param type the type 083 * @param init the initial value 084 */ 085 protected BooleanControl(Type type, boolean init) 086 { 087 super(type); 088 this.value = init; 089 this.trueLabel = "true"; 090 this.falseLabel = "false"; 091 } 092 093 /** 094 * Create a new boolean control, with the indicated Type, initial 095 * value, and labels. 096 * @param type the type 097 * @param init the initial value 098 * @param trueLabel the label for the true state 099 * @param falseLabel the label for the false state 100 */ 101 protected BooleanControl(Type type, boolean init, String trueLabel, 102 String falseLabel) 103 { 104 super(type); 105 this.value = init; 106 this.trueLabel = trueLabel; 107 this.falseLabel = falseLabel; 108 } 109 110 /** 111 * Return the label corresponding to the indicated state. 112 * @param state the state 113 * @return the true label or the false label, as appropriate 114 */ 115 public String getStateLabel(boolean state) 116 { 117 return state ? trueLabel : falseLabel; 118 } 119 120 /** 121 * Return the current value of thhe control. 122 */ 123 public boolean getValue() 124 { 125 return value; 126 } 127 128 /** 129 * Set the value of the control as indicated. 130 * @param value the new value 131 */ 132 public void setValue(boolean value) 133 { 134 this.value = value; 135 } 136 137 /** 138 * Return a string describing this control. 139 */ 140 public String toString() 141 { 142 return super.toString() + ": " + getStateLabel(value); 143 } 144}