1/*
2 * Copyright (c) 1999, 2017, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package javax.sound.sampled;
27
28/**
29 * A {@code CompoundControl}, such as a graphic equalizer, provides control over
30 * two or more related properties, each of which is itself represented as a
31 * {@code Control}.
32 *
33 * @author Kara Kytle
34 * @since 1.3
35 */
36public abstract class CompoundControl extends Control {
37
38    /**
39     * The set of member controls.
40     */
41    private final Control[] controls;
42
43    /**
44     * Constructs a new compound control object with the given parameters.
45     *
46     * @param  type the type of control represented this compound control object
47     * @param  memberControls the set of member controls
48     */
49    protected CompoundControl(Type type, Control[] memberControls) {
50        super(type);
51        this.controls = memberControls;
52    }
53
54    /**
55     * Returns the set of member controls that comprise the compound control.
56     *
57     * @return the set of member controls
58     */
59    public Control[] getMemberControls() {
60        Control[] localArray = new Control[controls.length];
61
62        for (int i = 0; i < controls.length; i++) {
63            localArray[i] = controls[i];
64        }
65
66        return localArray;
67    }
68
69    /**
70     * Provides a string representation of the control.
71     *
72     * @return a string description
73     */
74    @Override
75    public String toString() {
76
77        StringBuilder sb = new StringBuilder();
78        for (int i = 0; i < controls.length; i++) {
79            if (i != 0) {
80                sb.append(", ");
81                if ((i + 1) == controls.length) {
82                    sb.append("and ");
83                }
84            }
85            sb.append(controls[i].getType());
86        }
87
88        return new String(getType() + " Control containing " + sb + " Controls.");
89    }
90
91    /**
92     * An instance of the {@code CompoundControl.Type} inner class identifies
93     * one kind of compound control.
94     *
95     * @author Kara Kytle
96     * @since 1.3
97     */
98    public static class Type extends Control.Type {
99
100        /**
101         * Constructs a new compound control type.
102         *
103         * @param  name the name of the new compound control type
104         */
105        protected Type(final String name) {
106            super(name);
107        }
108    }
109}
110