linuxsampler/lscp/MidiPort.java

/*
 *   jlscp - a java LinuxSampler control protocol API
 *
 *   Copyright (C) 2005-2006 Grigor Iliev <grigor@grigoriliev.com>
 *
 *   This file is part of jlscp.
 *
 *   jlscp is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License version 2
 *   as published by the Free Software Foundation.
 *
 *   jlscp 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 for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with jlscp; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *   MA  02111-1307  USA
 */

package org.linuxsampler.lscp;

import java.util.Vector;


/**
 * This class is used to provide detailed information about a MIDI port.
 * @author  Grigor Iliev
 */
public class MidiPort {
        private Parameter<String> name;
        private final Vector<Parameter> prmList = new Vector<Parameter>();
        
        /**
         * Gets the name of this MIDI port.
         * @return The name of this MIDI port.
         */
        public String
        getName() { return name == null ? null : name.getValue(); }
        
        /**
         * Gets the <code>NAME</code> parameter.
         * @return A <code>Parameter<String></code> instance.
         */
        public Parameter<String>
        getNameParameter() { return name; }
        
        /**
         * Sets the <code>NAME</code> parameter.
         * @param name A <code>Parameter<String></code> instance.
         */
        public void
        setNameParameter(Parameter<String> name) { this.name = name; }
        
        /**
         * Adds additional parameter to this MIDI port.
         * @param prm The additional parameter to be added.
         */
        public void
        addParameter(Parameter prm) { prmList.add(prm); }
        
        /**
         * Gets <code>Parameter</code> array with the additional parameters of this MIDI port.
         * @return <code>Parameter</code> array with the additional parameters of this MIDI port.
         */
        public Parameter[]
        getAdditionalParameters() { return prmList.toArray(new Parameter[prmList.size()]); }
        
        /**
         * Determines whether this MIDI port has additional parameters.
         * @return <code>true</code> if this MIDI port has additional parameters,
         *  <code>false</code> otherwise. 
         */
        public boolean
        hasAdditionalParameters() { return !prmList.isEmpty(); }
        
        /**
         * Gets a <code>Parameter</code> array providing all parameters
         * of this MIDI port (including <code>NAME</code> parameter).
         * @return A <code>Parameter</code> array providing all parameters
         * of this MIDI port.
         */
        public Parameter[]
        getAllParameters() {
                Parameter[] params = new Parameter[prmList.size() + 1];
                params[0] = getNameParameter();
                for(int i = 0; i < prmList.size(); i++) params[i + 1] = prmList.get(i);
                return params;
        }
        
        /**
         * Returns the name of this MIDI port.
         * @return The name of this MIDI port.
         */
        public String
        toString() { return getName(); }
}
1	iliev	596	/*
2			* jlscp - a java LinuxSampler control protocol API
3			*
4	iliev	1139	* Copyright (C) 2005-2006 Grigor Iliev <grigor@grigoriliev.com>
5	iliev	596	*
6			* This file is part of jlscp.
7			*
8			* jlscp is free software; you can redistribute it and/or modify
9			* it under the terms of the GNU General Public License version 2
10			* as published by the Free Software Foundation.
11			*
12			* jlscp is distributed in the hope that it will be useful,
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			* GNU General Public License for more details.
16			*
17			* You should have received a copy of the GNU General Public License
18			* along with jlscp; if not, write to the Free Software
19			* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
20			* MA 02111-1307 USA
21			*/
22
23			package org.linuxsampler.lscp;
24
25			import java.util.Vector;
26
27
28			/**
29			* This class is used to provide detailed information about a MIDI port.
30			* @author Grigor Iliev
31			*/
32			public class MidiPort {
33	iliev	784	private Parameter<String> name;
34	iliev	596	private final Vector<Parameter> prmList = new Vector<Parameter>();
35
36			/**
37			* Gets the name of this MIDI port.
38			* @return The name of this MIDI port.
39			*/
40			public String
41	iliev	784	getName() { return name == null ? null : name.getValue(); }
42	iliev	596
43			/**
44	iliev	784	* Gets the <code>NAME</code> parameter.
45			* @return A <code>Parameter<String></code> instance.
46	iliev	596	*/
47	iliev	784	public Parameter<String>
48			getNameParameter() { return name; }
49
50			/**
51			* Sets the <code>NAME</code> parameter.
52			* @param name A <code>Parameter<String></code> instance.
53			*/
54	iliev	596	public void
55	iliev	784	setNameParameter(Parameter<String> name) { this.name = name; }
56	iliev	596
57			/**
58			* Adds additional parameter to this MIDI port.
59			* @param prm The additional parameter to be added.
60			*/
61			public void
62			addParameter(Parameter prm) { prmList.add(prm); }
63
64			/**
65			* Gets <code>Parameter</code> array with the additional parameters of this MIDI port.
66			* @return <code>Parameter</code> array with the additional parameters of this MIDI port.
67			*/
68			public Parameter[]
69			getAdditionalParameters() { return prmList.toArray(new Parameter[prmList.size()]); }
70
71			/**
72			* Determines whether this MIDI port has additional parameters.
73			* @return <code>true</code> if this MIDI port has additional parameters,
74			* <code>false</code> otherwise.
75			*/
76			public boolean
77			hasAdditionalParameters() { return !prmList.isEmpty(); }
78
79			/**
80	iliev	784	* Gets a <code>Parameter</code> array providing all parameters
81			* of this MIDI port (including <code>NAME</code> parameter).
82			* @return A <code>Parameter</code> array providing all parameters
83			* of this MIDI port.
84			*/
85			public Parameter[]
86			getAllParameters() {
87			Parameter[] params = new Parameter[prmList.size() + 1];
88			params[0] = getNameParameter();
89			for(int i = 0; i < prmList.size(); i++) params[i + 1] = prmList.get(i);
90			return params;
91			}
92
93			/**
94	iliev	596	* Returns the name of this MIDI port.
95			* @return The name of this MIDI port.
96			*/
97			public String
98			toString() { return getName(); }
99			}