linuxsampler/lscp/Driver.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;

/**
 * Defines the generic properties that every driver should have.
 * @author  Grigor Iliev
 */
public interface Driver {
        /**
         * Gets the name of this driver.
         * @return The name of this driver.
         */
        public String getName();
        
        /**
         * Gets a description about this driver.
         * @return A description about this driver.
         */
        public String getDescription();
        
        /**
         * Gets the version of this driver.
         * @return The version of this driver.
         */
        public String getVersion();
        
        /**
         * Gets all parameters available for this driver.
         * @return <code>Parameter</code> array with all parameters available for this driver.
         */
        public Parameter[] getParameters();
        
        /**
         * Gets the names of all parameters available for this driver.
         * @return <code>String</code> array with the names of all parameters
         * available for this driver.
         */
        public String[] getParameterNames();
}
1	/*
2	* jlscp - a java LinuxSampler control protocol API
3	*
4	* Copyright (C) 2005-2006 Grigor Iliev <grigor@grigoriliev.com>
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	/**
26	* Defines the generic properties that every driver should have.
27	* @author Grigor Iliev
28	*/
29	public interface Driver {
30	/**
31	* Gets the name of this driver.
32	* @return The name of this driver.
33	*/
34	public String getName();
35
36	/**
37	* Gets a description about this driver.
38	* @return A description about this driver.
39	*/
40	public String getDescription();
41
42	/**
43	* Gets the version of this driver.
44	* @return The version of this driver.
45	*/
46	public String getVersion();
47
48	/**
49	* Gets all parameters available for this driver.
50	* @return <code>Parameter</code> array with all parameters available for this driver.
51	*/
52	public Parameter[] getParameters();
53
54	/**
55	* Gets the names of all parameters available for this driver.
56	* @return <code>String</code> array with the names of all parameters
57	* available for this driver.
58	*/
59	public String[] getParameterNames();
60	}