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

/**
 * Thrown to indicate that LinuxSampler has returned an error message.
 * @author  Grigor Iliev
 */
public class LSException extends Exception {
        private int code;
        private String details = null;
        
        /** 
         * Creates a new instance of LSException with the specified error code and detail message.
         * @param code Specifies the error code.
         * @param msg Specifies the detail message.
         */
        public
        LSException(int code, String msg) {
                this(code, msg, null);
        }
        
        /** 
         * Creates a new instance of LSException with the specified error code and detail message.
         * @param code Specifies the error code.
         * @param msg Specifies the detail message.
         */
        public
        LSException(int code, String msg, String details) {
                super(msg);
                this.code = code;
                this.details = details;
        }
        
        /**
         * Gets the numeric unique identifier of the error.
         * @return The numeric unique identifier of the error.
         */
        public int
        getCode() { return code; }
        
        /**
         * Gets a detailed error report.
         * @return A detailed error report or <code>null</code> if there is no such.
         */
        public String
        getDetails() { return details; }
}
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			/**
26			* Thrown to indicate that LinuxSampler has returned an error message.
27			* @author Grigor Iliev
28			*/
29			public class LSException extends Exception {
30			private int code;
31	iliev	1202	private String details = null;
32	iliev	596
33			/**
34			* Creates a new instance of LSException with the specified error code and detail message.
35			* @param code Specifies the error code.
36			* @param msg Specifies the detail message.
37			*/
38			public
39			LSException(int code, String msg) {
40	iliev	1202	this(code, msg, null);
41			}
42
43			/**
44			* Creates a new instance of LSException with the specified error code and detail message.
45			* @param code Specifies the error code.
46			* @param msg Specifies the detail message.
47			*/
48			public
49			LSException(int code, String msg, String details) {
50	iliev	596	super(msg);
51			this.code = code;
52	iliev	1202	this.details = details;
53	iliev	596	}
54
55			/**
56			* Gets the numeric unique identifier of the error.
57			* @return The numeric unique identifier of the error.
58			*/
59			public int
60			getCode() { return code; }
61	iliev	1202
62			/**
63			* Gets a detailed error report.
64			* @return A detailed error report or <code>null</code> if there is no such.
65			*/
66			public String
67			getDetails() { return details; }
68	iliev	596	}