jdk/src/share/classes/javax/sound/sampled/CompoundControl.java
changeset 2 90ce3da70b43
child 5506 202f599c92aa
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/jdk/src/share/classes/javax/sound/sampled/CompoundControl.java	Sat Dec 01 00:00:00 2007 +0000
@@ -0,0 +1,140 @@
+/*
+ * Copyright 1999-2003 Sun Microsystems, Inc.  All Rights Reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Sun designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Sun in the LICENSE file that accompanied this code.
+ *
+ * This code 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
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
+ * CA 95054 USA or visit www.sun.com if you need additional information or
+ * have any questions.
+ */
+
+package javax.sound.sampled;
+
+/**
+ * A <code>CompoundControl</code>, such as a graphic equalizer, provides control
+ * over two or more related properties, each of which is itself represented as
+ * a <code>Control</code>.
+ *
+ * @author Kara Kytle
+ * @since 1.3
+ */
+public abstract class CompoundControl extends Control {
+
+
+    // TYPE DEFINES
+
+
+    // INSTANCE VARIABLES
+
+
+    /**
+     * The set of member controls.
+     */
+    private Control[] controls;
+
+
+
+    // CONSTRUCTORS
+
+
+    /**
+     * Constructs a new compound control object with the given parameters.
+     *
+     * @param type the type of control represented this compound control object
+     * @param memberControls the set of member controls
+     */
+    protected CompoundControl(Type type, Control[] memberControls) {
+
+        super(type);
+        this.controls = memberControls;
+    }
+
+
+
+    // METHODS
+
+
+    /**
+     * Returns the set of member controls that comprise the compound control.
+     * @return the set of member controls.
+     */
+    public Control[] getMemberControls() {
+
+        Control[] localArray = new Control[controls.length];
+
+        for (int i = 0; i < controls.length; i++) {
+            localArray[i] = controls[i];
+        }
+
+        return localArray;
+    }
+
+
+    // ABSTRACT METHOD IMPLEMENTATIONS: CONTROL
+
+
+    /**
+     * Provides a string representation of the control
+     * @return a string description
+     */
+    public String toString() {
+
+        StringBuffer buf = new StringBuffer();
+        for (int i = 0; i < controls.length; i++) {
+            if (i != 0) {
+                buf.append(", ");
+                if ((i + 1) == controls.length) {
+                    buf.append("and ");
+                }
+            }
+            buf.append(controls[i].getType());
+        }
+
+        return new String(getType() + " Control containing " + buf + " Controls.");
+    }
+
+
+    // INNER CLASSES
+
+
+    /**
+     * An instance of the <code>CompoundControl.Type</code> inner class identifies one kind of
+     * compound control.  Static instances are provided for the
+     * common types.
+     *
+     * @author Kara Kytle
+     * @since 1.3
+     */
+    public static class Type extends Control.Type {
+
+
+        // TYPE DEFINES
+
+        // CONSTRUCTOR
+
+
+        /**
+         * Constructs a new compound control type.
+         * @param name  the name of the new compound control type
+         */
+        protected Type(String name) {
+            super(name);
+        }
+    } // class Type
+
+} // class CompoundControl