/*
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */
package org.apache.tools.ant.taskdefs.optional;

import java.io.File;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.types.Path;
import org.apache.tools.ant.types.Reference;
import org.apache.tools.ant.util.ScriptRunnerHelper;

Executes a script.
@ant.task
name="script"/**
 * Executes a script.
 *
 * @ant.task name="script"
 */
public class Script extends Task {

    private ScriptRunnerHelper helper = new ScriptRunnerHelper();

    
Set the project.
Params:
project – the project that this task belongs to./**
     * Set the project.
     * @param project the project that this task belongs to.
     */
    public void setProject(Project project) {
        super.setProject(project);
        helper.setProjectComponent(this);
    }

    
Run the script using the helper object.
Throws:
BuildException – if something goes wrong with the build/**
     * Run the script using the helper object.
     *
     * @exception BuildException if something goes wrong with the build
     */
    public void execute() throws BuildException {
        helper.getScriptRunner().executeScript("ANT");
    }

    
Defines the manager.
Params:
manager – the scripting manager./**
     * Defines the manager.
     *
     * @param manager the scripting manager.
     */
    public void setManager(String manager) {
        helper.setManager(manager);
    }

    
Defines the language (required).
Params:
language – the scripting language name for the script./**
     * Defines the language (required).
     *
     * @param language the scripting language name for the script.
     */
    public void setLanguage(String language) {
        helper.setLanguage(language);
    }

    
Load the script from an external file; optional.
Params:
fileName – the name of the file containing the script source./**
     * Load the script from an external file; optional.
     *
     * @param fileName the name of the file containing the script source.
     */
    public void setSrc(String fileName) {
        helper.setSrc(new File(fileName));
    }

    
Set the script text.
Params:
text – a component of the script text to be added./**
     * Set the script text.
     *
     * @param text a component of the script text to be added.
     */
    public void addText(String text) {
        helper.addText(text);
    }

    
Set the classpath to be used when searching for classes and resources.
Params:
classpath – an Ant Path object containing the search path./**
     * Set the classpath to be used when searching for classes and resources.
     *
     * @param classpath an Ant Path object containing the search path.
     */
    public void setClasspath(Path classpath) {
        helper.setClasspath(classpath);
    }

    
Classpath to be used when searching for classes and resources.
Returns:
an empty Path instance to be configured by Ant./**
     * Classpath to be used when searching for classes and resources.
     *
     * @return an empty Path instance to be configured by Ant.
     */
    public Path createClasspath() {
        return helper.createClasspath();
    }

    
Set the classpath by reference.
Params:
r – a Reference to a Path instance to be used as the classpath
         value./**
     * Set the classpath by reference.
     *
     * @param r a Reference to a Path instance to be used as the classpath
     *          value.
     */
    public void setClasspathRef(Reference r) {
        helper.setClasspathRef(r);
    }

    
Set the setbeans attribute.
If this is true, <script> will create variables in the
script instance for all
properties, targets and references of the current project.
It this is false, only the project and self variables will
be set.
The default is true.
Params:
setBeans – the value to set./**
     * Set the setbeans attribute.
     * If this is true, &lt;script&gt; will create variables in the
     * script instance for all
     * properties, targets and references of the current project.
     * It this is false, only the project and self variables will
     * be set.
     * The default is true.
     * @param setBeans the value to set.
     */
    public void setSetBeans(boolean setBeans) {
        helper.setSetBeans(setBeans);
    }

    
Set the encoding of the script from an external file; optional.
Params:
encoding – the encoding of the file containing the script source.
Since:
Ant 1.10.2/**
     * Set the encoding of the script from an external file; optional.
     *
     * @param encoding the encoding of the file containing the script source.
     * @since Ant 1.10.2
     */
    public void setEncoding(String encoding) {
        helper.setEncoding(encoding);
    }

}