ScriptBot Code

/*
 * Created on 15.11.2005 by jawe
 * $Id$
 */
/*
 * This file is part of scriptbot.
 *
 * scriptbot is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * scriptbot 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 ScriptBot; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
package net.jawe.scriptbot;

import java.io.File;
import java.io.IOException;
import java.util.Set;

/**
 * A script.
 * @author jawe
 */
public interface Script {

    /**
     * Last modification time of the script file.
     * @return Returns the lastModified.
     */
    public long getLastModified();

    /**
     * The script code.
     * @return Returns the code.
     * @throws IOException if loading the {@link #getFile() script file} fails.
     */
    public String getCode() throws IOException;

    /**
     * The script file.
     * @return Returns the file.
     */
    public File getFile();
    
    /**
     * The script file.
     * @param file the file to set.
     */
    public void setFile(File file);
    
    /**
     * The list of scripts ot be prepended to this script.
     * @return the list of prefix scripts.
     */
    public Set<Script> getPrefixScripts();
    
    /**
     * Reload the script file into the code property.
     * @throws IOException
     *             if any
     */
    public void reload() throws IOException;

    /**
     * Test if the script file was modified since it was last loaded.
     * @return wether the file was modified since last load.
     */
    public boolean isModfied();

    /**
     * Should the script be executed asynchronously, eg in it's own thread?
     * @return true if the script is to be executed asynchronously.
     */
    public boolean isAsync();
    
    /**
     * Set wether the script is to be executed asynchronously, eg in it's own thread?
     * @param async Should the script be executed asynchronously, eg in it's own thread?
     */
    public void setAsync(boolean async);

    /**
     * The class loader used for loading classes referenced by the script.
     * @return the class loader.
     */
    public ClassLoader getClassLoader();
    
    /**
     * The class loader used for loading classes referenced by the script.
     * @param cl the class loader.
     */
    public void setClassLoader(ClassLoader cl);

}