linuxsampler/lscp/Device.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 device should have.
 *
 * @author  Grigor Iliev
 */
public interface Device {
        /**
         * Gets the numerical ID of this device.
         * @return The numerical ID of this device or -1 if the device number is not set.
         */
        public int getDeviceId();
        
        /**
         * Gets the driver name used by this device.
         * @return The driver name used by this device.
         */
        public String getDriverName();
        
        /**
         * Determines whether this device is active.
         * @return <code>false</code> if the device is inactive and <code>true</code> otherwise.
         */
        public boolean isActive();
        
        /**
         * Gets the <code>ACTIVE</code> parameter.
         * @return A <code>Parameter<Boolean></code> instance
         * representing the active state of the device.
         */
        public Parameter<Boolean> getActiveParameter();
        
        /**
         * Gets <code>Parameter</code> array with the additional parameters of this device.
         * @return <code>Parameter</code> array with the additional parameters of this device.
         */
        public Parameter[]
        getAdditionalParameters();
        
        /**
         * Determines whether this device has additional parameters.
         * @return <code>true</code> if this device has additional parameters,
         *  <code>false</code> otherwise. 
         */
        public boolean
        hasAdditionalParameters();
}
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 device should have.
27	*
28	* @author Grigor Iliev
29	*/
30	public interface Device {
31	/**
32	* Gets the numerical ID of this device.
33	* @return The numerical ID of this device or -1 if the device number is not set.
34	*/
35	public int getDeviceId();
36
37	/**
38	* Gets the driver name used by this device.
39	* @return The driver name used by this device.
40	*/
41	public String getDriverName();
42
43	/**
44	* Determines whether this device is active.
45	* @return <code>false</code> if the device is inactive and <code>true</code> otherwise.
46	*/
47	public boolean isActive();
48
49	/**
50	* Gets the <code>ACTIVE</code> parameter.
51	* @return A <code>Parameter<Boolean></code> instance
52	* representing the active state of the device.
53	*/
54	public Parameter<Boolean> getActiveParameter();
55
56	/**
57	* Gets <code>Parameter</code> array with the additional parameters of this device.
58	* @return <code>Parameter</code> array with the additional parameters of this device.
59	*/
60	public Parameter[]
61	getAdditionalParameters();
62
63	/**
64	* Determines whether this device has additional parameters.
65	* @return <code>true</code> if this device has additional parameters,
66	* <code>false</code> otherwise.
67	*/
68	public boolean
69	hasAdditionalParameters();
70	}