javax.sound.sampled

Class EnumControl


public abstract class EnumControl
extends Control

An EnumControl is a Control which can take one of a specified set of values.
Since:
1.3

Nested Class Summary

static class
EnumControl.Type
This Type describes an EnumControl.

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

Control.Type

Constructor Summary

EnumControl(EnumControl.Type type, Object[] values, Object val)
Create a new enumerated control given its Type, the range of valid values, and its initial value.

Method Summary

Object
getValue()
Return the current value of this control.
Object[]
getValues()
Return the valid values for this control.
void
setValue(Object value)
Set the value of this control.
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

EnumControl

protected EnumControl(EnumControl.Type type,
                      Object[] values,
                      Object val)
Create a new enumerated control given its Type, the range of valid values, and its initial value.
Parameters:
type - the type
values - the valid values
val - the initial value

Method Details

getValue

public Object getValue()
Return the current value of this control.

getValues

public Object[] getValues()
Return the valid values for this control.

setValue

public void setValue(Object value)
Set the value of this control. If the indicated value is not among the valid values, this method will throw an IllegalArgumentException.
Parameters:
value - the new value
Throws:
IllegalArgumentException - if the new value is invalid

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.