EnumControl (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.sound.sampled
class EnumControl

java.lang.Object
  javax.sound.sampled.Control
      javax.sound.sampled.EnumControl

public abstract class EnumControl
extends Control

A 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 {@link FloatControl} objects.

Controls that provide a choice between only two settings can often be implemented instead as a {@link 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 {@link EnumControl.Type#REVERB REVERB} control are instances of {@link ReverbType} that can be queried for the parameter values used for each setting.

Nested Class Summary
`static class`	`EnumControl.Type` An instance of the `EnumControl.Type` inner class identifies one kind of enumerated control.

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

Constructor Summary
`protected`	`EnumControl(EnumControl.Type type, Object[] values, Object value)` Constructs a new enumerated control object with the given parameters.

Method Summary
`Object`	`getValue()` Obtains this control's current value.
`Object[]`	`getValues()` Returns the set of possible values for this control.
`void`	`setValue(Object value)` Sets the current value for the control.
`String`	`toString()` Provides a string representation of the control.

Methods inherited from class javax.sound.sampled.Control
`getType, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

EnumControl

protected EnumControl(EnumControl.Type type,
                      Object[] values,
                      Object value)

Constructs a new enumerated control object with the given parameters.

Parameters:: type - the type of control represented this enumerated control object; values - the set of possible values for the control; value - the initial control value

Method Detail

getValue

public Object getValue()

Obtains this control's current value.

Returns:: the current value

getValues

public Object[] getValues()

Returns the set of possible values for this control.

Returns:: the set of possible values

setValue

public void setValue(Object value)

Sets the current value for the control. The default implementation simply sets the value as indicated. If the value indicated is not supported, an IllegalArgumentException 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

toString

public String toString()

Provides a string representation of the control.

Overrides:: toString in class Control
Returns:: a string description