001 /*
002 * Copyright 1999-2003 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.sound.sampled;
027
028 /**
029 * A <code>CompoundControl</code>, such as a graphic equalizer, provides control
030 * over two or more related properties, each of which is itself represented as
031 * a <code>Control</code>.
032 *
033 * @author Kara Kytle
034 * @version 1.17, 07/05/05
035 * @since 1.3
036 */
037 public abstract class CompoundControl extends Control {
038
039 // TYPE DEFINES
040
041 // INSTANCE VARIABLES
042
043 /**
044 * The set of member controls.
045 */
046 private Control[] controls;
047
048 // CONSTRUCTORS
049
050 /**
051 * Constructs a new compound control object with the given parameters.
052 *
053 * @param type the type of control represented this compound control object
054 * @param memberControls the set of member controls
055 */
056 protected CompoundControl(Type type, Control[] memberControls) {
057
058 super (type);
059 this .controls = memberControls;
060 }
061
062 // METHODS
063
064 /**
065 * Returns the set of member controls that comprise the compound control.
066 * @return the set of member controls.
067 */
068 public Control[] getMemberControls() {
069
070 Control[] localArray = new Control[controls.length];
071
072 for (int i = 0; i < controls.length; i++) {
073 localArray[i] = controls[i];
074 }
075
076 return localArray;
077 }
078
079 // ABSTRACT METHOD IMPLEMENTATIONS: CONTROL
080
081 /**
082 * Provides a string representation of the control
083 * @return a string description
084 */
085 public String toString() {
086
087 StringBuffer buf = new StringBuffer();
088 for (int i = 0; i < controls.length; i++) {
089 if (i != 0) {
090 buf.append(", ");
091 if ((i + 1) == controls.length) {
092 buf.append("and ");
093 }
094 }
095 buf.append(controls[i].getType());
096 }
097
098 return new String(getType() + " Control containing " + buf
099 + " Controls.");
100 }
101
102 // INNER CLASSES
103
104 /**
105 * An instance of the <code>CompoundControl.Type</code> inner class identifies one kind of
106 * compound control. Static instances are provided for the
107 * common types.
108 *
109 * @author Kara Kytle
110 * @version 1.17, 07/05/05
111 * @since 1.3
112 */
113 public static class Type extends Control.Type {
114
115 // TYPE DEFINES
116
117 // CONSTRUCTOR
118
119 /**
120 * Constructs a new compound control type.
121 * @param name the name of the new compound control type
122 */
123 protected Type(String name) {
124 super (name);
125 }
126 } // class Type
127
128 } // class CompoundControl
|