javax.sound.sampled

Class BooleanControl


public abstract class BooleanControl
extends Control

A BooleanControl is a Control which has two states.
Since:
1.3

Nested Class Summary

static class
BooleanControl.Type
A Type specialized to represent a boolean control.

Nested classes/interfaces inherited from class javax.sound.sampled.Control

Control.Type

Constructor Summary

BooleanControl(BooleanControl.Type type, boolean init)
Create a new boolean control, with the indicated Type and initial value.
BooleanControl(BooleanControl.Type type, boolean init, String trueLabel, String falseLabel)
Create a new boolean control, with the indicated Type, initial value, and labels.

Method Summary

String
getStateLabel(boolean state)
Return the label corresponding to the indicated state.
boolean
getValue()
Return the current value of thhe control.
void
setValue(boolean value)
Set the value of the control as indicated.
String
toString()
Return a string describing this control.

Methods inherited from class javax.sound.sampled.Control

getType, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BooleanControl

protected BooleanControl(BooleanControl.Type type,
                         boolean init)
Create a new boolean control, with the indicated Type and initial value. The description strings will default to "true" and "false".
Parameters:
type - the type
init - the initial value

BooleanControl

protected BooleanControl(BooleanControl.Type type,
                         boolean init,
                         String trueLabel,
                         String falseLabel)
Create a new boolean control, with the indicated Type, initial value, and labels.
Parameters:
type - the type
init - the initial value
trueLabel - the label for the true state
falseLabel - the label for the false state

Method Details

getStateLabel

public String getStateLabel(boolean state)
Return the label corresponding to the indicated state.
Parameters:
state - the state
Returns:
the true label or the false label, as appropriate

getValue

public boolean getValue()
Return the current value of thhe control.

setValue

public void setValue(boolean value)
Set the value of the control as indicated.
Parameters:
value - the new value

toString

public String toString()
Return a string describing this control.
Overrides:
toString in interface Control

Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.