java.lang.Object
javax.sound.sampled.Control
javax.sound.sampled.EnumControl
An
EnumControl
provides control over a set of discrete possible
values, each represented by an object. In a graphical user interface, such a
control might be represented by a set of buttons, each of which chooses one
value or setting. For example, a reverb control might provide several preset
reverberation settings, instead of providing continuously adjustable
parameters of the sort that would be represented by FloatControl
objects.
Controls that provide a choice between only two settings can often be
implemented instead as a BooleanControl
, and controls that provide a
set of values along some quantifiable dimension might be implemented instead
as a FloatControl
with a coarse resolution. However, a key feature of
EnumControl
is that the returned values are arbitrary objects, rather
than numerical or boolean values. This means that each returned object can
provide further information. As an example, the settings of a
REVERB
control are instances of
ReverbType
that can be queried for the parameter values used for each
setting.
- Since:
- 1.3
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An instance of theEnumControl.Type
inner class identifies one kind of enumerated control. -
Constructor Summary
ModifierConstructorDescriptionprotected
EnumControl
(EnumControl.Type type, Object[] values, Object value) Constructs a new enumerated control object with the given parameters. -
Method Summary
-
Constructor Details
-
EnumControl
Constructs a new enumerated control object with the given parameters.- Parameters:
type
- the type of control represented this enumerated control objectvalues
- the set of possible values for the controlvalue
- the initial control value
-
-
Method Details
-
setValue
Sets the current value for the control. The default implementation simply sets the value as indicated. If the value indicated is not supported, anIllegalArgumentException
is thrown. Some controls require that their line be open before they can be affected by setting a value.- Parameters:
value
- the desired new value- Throws:
IllegalArgumentException
- if the value indicated does not fall within the allowable range
-
getValue
Obtains this control's current value.- Returns:
- the current value
-
getValues
Returns the set of possible values for this control.- Returns:
- the set of possible values
-
toString
Returns a string representation of the enumerated control.
-