jsampler/task/EnhancedTask.java

/*
 *   JSampler - a java front-end for LinuxSampler
 *
 *   Copyright (C) 2005-2006 Grigor Iliev <grigor@grigoriliev.com>
 *
 *   This file is part of JSampler.
 *
 *   JSampler 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.
 *
 *   JSampler 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 JSampler; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *   MA  02111-1307  USA
 */

package org.jsampler.task;

import net.sf.juife.AbstractTask;

import org.linuxsampler.lscp.LSException;


/**
 * This class extends <code>AbstractTask</code> to add new features.
 * @author Grigor Iliev
 */
public abstract class EnhancedTask<R> extends AbstractTask<R> {
        private boolean stopped = false;
        private boolean silent = false;
        
        /**
         * Marks that the execution of this task was interrupted.
         */
        public void
        stop() { stopped = true; }
        
        /**
         * Determines whether the execution of this task was interrupted.
         * @return <code>true</code> if the execution of this task was interrupted,
         * <code>false</code> otherwise.
         */
        public boolean
        isStopped() { return stopped; }
        
        /**
         * Determines whether an error message should be shown
         * if the execution of the task fail.
         */
        public boolean
        isSilent() { return silent; }
        
        /**
         * DSets whether an error message should be shown
         * if the execution of the task fail.
         */
        public void
        setSilent(boolean b) { silent = b; }
        
        /**
         * Sets the error details provided by the given exception (if the given
         * exception is <code>LSException</code> instance and contains error details).
         */
        public void
        setErrorDetails(Exception e) {
                if(e == null) return;
                
                if(e instanceof LSException) {
                        LSException x = (LSException)e;
                        if(x.getDetails() != null && x.getDetails().length() > 0) {
                                setErrorDetails(x.getDetails());
                        }
                }
        }
}
1	/*
2	* JSampler - a java front-end for LinuxSampler
3	*
4	* Copyright (C) 2005-2006 Grigor Iliev <grigor@grigoriliev.com>
5	*
6	* This file is part of JSampler.
7	*
8	* JSampler 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	* JSampler 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 JSampler; 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.jsampler.task;
24
25	import net.sf.juife.AbstractTask;
26
27	import org.linuxsampler.lscp.LSException;
28
29
30	/**
31	* This class extends <code>AbstractTask</code> to add new features.
32	* @author Grigor Iliev
33	*/
34	public abstract class EnhancedTask<R> extends AbstractTask<R> {
35	private boolean stopped = false;
36	private boolean silent = false;
37
38	/**
39	* Marks that the execution of this task was interrupted.
40	*/
41	public void
42	stop() { stopped = true; }
43
44	/**
45	* Determines whether the execution of this task was interrupted.
46	* @return <code>true</code> if the execution of this task was interrupted,
47	* <code>false</code> otherwise.
48	*/
49	public boolean
50	isStopped() { return stopped; }
51
52	/**
53	* Determines whether an error message should be shown
54	* if the execution of the task fail.
55	*/
56	public boolean
57	isSilent() { return silent; }
58
59	/**
60	* DSets whether an error message should be shown
61	* if the execution of the task fail.
62	*/
63	public void
64	setSilent(boolean b) { silent = b; }
65
66	/**
67	* Sets the error details provided by the given exception (if the given
68	* exception is <code>LSException</code> instance and contains error details).
69	*/
70	public void
71	setErrorDetails(Exception e) {
72	if(e == null) return;
73
74	if(e instanceof LSException) {
75	LSException x = (LSException)e;
76	if(x.getDetails() != null && x.getDetails().length() > 0) {
77	setErrorDetails(x.getDetails());
78	}
79	}
80	}
81	}