linuxsampler/lscp/MidiPort.java

/*
 *   jlscp - a java LinuxSampler control protocol API
 *
 *   Copyright (C) 2005 Grigor Kirilov Iliev
 *
 *   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 String name = null;
        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; }
        
        /**
         * Sets the name of this MIDI port.
         * @param name A <code>String</code> object containing the new name for this MIDI port.
         */
        public void
        setName(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(); }
        
        /**
         * Returns the name of this MIDI port.
         * @return The name of this MIDI port.
         */
        public String
        toString() { return getName(); }
}
1	/*
2	* jlscp - a java LinuxSampler control protocol API
3	*
4	* Copyright (C) 2005 Grigor Kirilov Iliev
5	*
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	private String name = null;
34	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	getName() { return name; }
42
43	/**
44	* Sets the name of this MIDI port.
45	* @param name A <code>String</code> object containing the new name for this MIDI port.
46	*/
47	public void
48	setName(String name) { this.name = name; }
49
50	/**
51	* Adds additional parameter to this MIDI port.
52	* @param prm The additional parameter to be added.
53	*/
54	public void
55	addParameter(Parameter prm) { prmList.add(prm); }
56
57	/**
58	* Gets <code>Parameter</code> array with the additional parameters of this MIDI port.
59	* @return <code>Parameter</code> array with the additional parameters of this MIDI port.
60	*/
61	public Parameter[]
62	getAdditionalParameters() { return prmList.toArray(new Parameter[prmList.size()]); }
63
64	/**
65	* Determines whether this MIDI port has additional parameters.
66	* @return <code>true</code> if this MIDI port has additional parameters,
67	* <code>false</code> otherwise.
68	*/
69	public boolean
70	hasAdditionalParameters() { return !prmList.isEmpty(); }
71
72	/**
73	* Returns the name of this MIDI port.
74	* @return The name of this MIDI port.
75	*/
76	public String
77	toString() { return getName(); }
78	}