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 26 package javax.sound.sampled; 27 28 /** 29 * {@link Line Lines} often have a set of controls, such as gain and pan, that 30 * affect the audio signal passing through the line. Java Sound's {@code Line} 31 * objects let you obtain a particular control object by passing its class as 32 * the argument to a {@link Line#getControl(Control.Type) getControl} method. 33 * <p> 34 * Because the various types of controls have different purposes and features, 35 * all of their functionality is accessed from the subclasses that define each 36 * kind of control. 37 * 38 * @author Kara Kytle 39 * @see Line#getControls 40 * @see Line#isControlSupported 41 * @since 1.3 42 */ 43 public abstract class Control { 44 45 /** 46 * The control type. 47 */ 48 private final Type type; 49 50 /** 51 * Constructs a control with the specified type. 52 * 53 * @param type the kind of control desired 54 */ 55 protected Control(Type type) { 56 this.type = type; 57 } 58 59 /** 60 * Obtains the control's type. 61 * 62 * @return the control's type 63 */ 64 public Type getType() { 65 return type; 66 } 67 68 /** 69 * Obtains a string describing the control type and its current state. 70 * 71 * @return a string representation of the control 72 */ 73 @Override 74 public String toString() { 75 return new String(getType() + " Control"); 76 } 77 78 /** 79 * An instance of the {@code Type} class represents the type of the control. 80 */ 81 public static class Type { 82 83 /** 84 * Type name. 85 */ 86 private final String name; 87 88 /** 89 * Constructs a new control type with the name specified. The name 90 * should be a descriptive string appropriate for labelling the control 91 * in an application, such as "Gain" or "Balance". 92 * 93 * @param name the name of the new control type 94 */ 95 protected Type(String name) { 96 this.name = name; 97 } 98 99 /** 100 * Indicates whether the specified object is equal to this control type, 101 * returning {@code true} if the objects are the same. 102 * 103 * @param obj the reference object with which to compare 104 * @return {@code true} if the specified object is equal to this control 105 * type; {@code false} otherwise 106 */ 107 @Override 108 public final boolean equals(Object obj) { 109 return super.equals(obj); 110 } 111 112 /** 113 * Returns a hash code value for this control type. 114 * 115 * @return a hash code value for this control type 116 */ 117 @Override 118 public final int hashCode() { 119 return super.hashCode(); 120 } 121 122 /** 123 * Provides the {@code String} representation of the control type. This 124 * {@code String} is the same name that was passed to the constructor. 125 * 126 * @return the control type name 127 */ 128 @Override 129 public final String toString() { 130 return name; 131 } 132 } 133 }