Task.java

Go to the documentation of this file.

/*
 *   DENOPTIM
 *   Copyright (C) 2019 Vishwesh Venkatraman <vishwesh.venkatraman@ntnu.no>
 * 
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Affero General Public License as published
 *   by the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program 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 Affero General Public License for more details.
 *
 *   You should have received a copy of the GNU Affero General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package denoptim.task;
 
import java.io.File;
import java.util.concurrent.Callable;
 
 
public abstract class Task implements Callable<Object>
{
    protected boolean notifyGlobalTaskManager = false;
    
    protected boolean completed = false;
 
    protected boolean hasException = false;
    
    public Object lock = new Object();
    
    protected String errMsg = "";
 
    protected Throwable thrownExc;
 
    protected int id;
    
    protected ProcessHandler processHandler;
    
    protected File workDir;
    
    protected int verbosity = 0;
 
    protected final String SEP = System.getProperty("file.separator");
    
    protected final String NL = System.getProperty("line.separator");
   
//------------------------------------------------------------------------------
 
    public Task(final int id)
    {
        this.id = id;
    }
 
//------------------------------------------------------------------------------
 
    public int getId()
    {
        return id;
    }
    
//------------------------------------------------------------------------------
 
    public void setVerbosity(int verbosity)
    {
        this.verbosity = verbosity;
    }
//------------------------------------------------------------------------------
    
    public void setWorkSpace(File workDir)
    {
        this.workDir = workDir;
    }
    
//------------------------------------------------------------------------------
    
    public boolean isCompleted()
    {
        return completed;
    }
 
//------------------------------------------------------------------------------
    
    public boolean foundException()
    {
        return hasException;
    }
 
//------------------------------------------------------------------------------
 
    public Throwable getException()
    {
        return thrownExc;
    }
    
//------------------------------------------------------------------------------
 
    public String getErrorMessage()
    {
        return errMsg;
    }
    
//------------------------------------------------------------------------------
 
    public void stopTask()
    {
        if (completed)
        {
            return;
        }
        if (processHandler != null)
        {
            System.err.println("Calling stop on processes from " 
                    + this.getClass().getName() + " " + id);
            processHandler.stopProcess();
        } else {
            if (notifyGlobalTaskManager)
            {
                StaticTaskManager.subtractDoneTask();
            }
            Thread.currentThread().interrupt();
        }
    }
    
//------------------------------------------------------------------------------
 
    @Override
    public String toString()
    {
        StringBuilder sb = new StringBuilder();
        sb.append(this.getClass().getName());
        sb.append(" [id=").append(id);
        sb.append(", hasException=").append(hasException);
        sb.append(", completed=").append(completed).append("] ");
        return sb.toString();
    }
    
//------------------------------------------------------------------------------
 
    public void setNotify(boolean notify) 
    {
        this.notifyGlobalTaskManager = notify;
    }
    
//------------------------------------------------------------------------------    
 
}