libjava/classpath/javax/sound/sampled/CompoundControl.java

   1 /* Control consisting of several other controls
   2    Copyright (C) 2005 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.sound.sampled;
  40
  41 import gnu.java.lang.CPStringBuilder;
  42
  43 /**
  44  * A compound control provides control over several other controls.
  45  * @since 1.3
  46  */
  47 public abstract class CompoundControl extends Control
  48 {
  49   /**
  50    * This describes a single compound control.
  51    * @since 1.3
  52    */
  53   public static class Type extends Control.Type
  54   {
  55     /**
  56      * Create a new Type given its name.
  57      * @param name the name of the type
  58      */
  59     protected Type(String name)
  60     {
  61       super(name);
  62     }
  63   }
  64
  65   private Control[] memberControls;
  66
  67   /**
  68    * Create a new compound control given its type and members.
  69    * @param type the type of the compound control
  70    * @param members the members of the compound control
  71    */
  72   protected CompoundControl(Type type, Control[] members)
  73   {
  74     super(type);
  75     // FIXME: clone?
  76     this.memberControls = members;
  77   }
  78
  79   /**
  80    * Return the members of this compound control.
  81    */
  82   public Control[] getMemberControls()
  83   {
  84     // FIXME: clone?
  85     return memberControls;
  86   }
  87
  88   /**
  89    * Return a string description of this compound control.
  90    */
  91   public String toString()
  92   {
  93     CPStringBuilder result = new CPStringBuilder();
  94     result.append(super.toString());
  95     result.append(": ");
  96     for (int i = 0; i < memberControls.length; ++i)
  97       {
  98         if (i > 0)
  99           result.append(", ");
 100         result.append(memberControls[i].toString());
 101       }
 102     return result.toString();
 103   }
 104 }