Class Script

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.optional.Script

All Implemented Interfaces:

Cloneable

public class Script
extends Task

Executes a script.

Field Summary

Fields inherited from class Task

target, taskName, taskType, wrapper

Modifier and Type	Field	Description
protected Target	target	Deprecated. since 1.6.x.
protected String	taskName	Deprecated. since 1.6.x.
protected String	taskType	Deprecated. since 1.6.x.
protected RuntimeConfigurable	wrapper	Deprecated. since 1.6.x.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
Script()

Method Summary

Modifier and Type	Method	Description
void	addText(String text)	Set the script text.
Path	createClasspath()	Classpath to be used when searching for classes and resources.
void	execute()	Run the script using the helper object.
void	setClasspath(Path classpath)	Set the classpath to be used when searching for classes and resources.
void	setClasspathRef(Reference r)	Set the classpath by reference.
void	setEncoding(String encoding)	Set the encoding of the script from an external file; optional.
void	setLanguage(String language)	Defines the language (required).
void	setManager(String manager)	Deprecated.
void	setManager(ScriptManager manager)	Set the script manager.
void	setProject(Project project)	Set the project.
void	setSetBeans(boolean setBeans)	Set the setbeans attribute.
void	setSrc(String fileName)	Load the script from an external file; optional.

Methods inherited from class Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Modifier and Type	Method	Description
final void	bindToOwner(Task owner)	Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
Target	getOwningTarget()	Returns the container target of this task.
RuntimeConfigurable	getRuntimeConfigurableWrapper()	Returns the wrapper used for runtime configuration.
String	getTaskName()	Returns the name to use in logging messages.
String	getTaskType()	Return the type of task.
protected RuntimeConfigurable	getWrapper()	Return the runtime configurable structure for this task.
protected void	handleErrorFlush(String output)	Handles an error line by logging it with the WARN priority.
protected void	handleErrorOutput(String output)	Handles an error output by logging it with the WARN priority.
protected void	handleFlush(String output)	Handles output by logging it with the INFO priority.
protected int	handleInput(byte[] buffer, int offset, int length)	Handle an input request by this task.
protected void	handleOutput(String output)	Handles output by logging it with the INFO priority.
void	init()	Called by the project to let the task initialize properly.
protected final boolean	isInvalid()	Has this task been marked invalid?
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	log(String msg, Throwable t, int msgLevel)	Logs a message with the given priority.
void	log(Throwable t, int msgLevel)	Logs a message with the given priority.
void	maybeConfigure()	Configures this task - if it hasn't been done already.
final void	perform()	Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
void	reconfigure()	Force the task to be reconfigured from its RuntimeConfigurable.
void	setOwningTarget(Target target)	Sets the target container of this task.
void	setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)	Sets the wrapper to be used for runtime configuration.
void	setTaskName(String name)	Sets the name to use in logging messages.
void	setTaskType(String type)	Sets the name with which the task has been invoked.

Methods inherited from class ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Script

public Script()

Method Details

setProject

public void setProject(Project project)

Set the project.

Overrides:

setProject in class ProjectComponent

Parameters:

project - the project that this task belongs to.

execute

public void execute()
             throws BuildException

Run the script using the helper object.

Overrides:

execute in class Task

Throws:

BuildException - if something goes wrong with the build

setManager

@Deprecated
public void setManager(String manager)

Deprecated.

Defines the manager.

Parameters:

manager - the scripting manager.

setManager

public void setManager(ScriptManager manager)

Set the script manager.

Parameters:

manager -

setLanguage

public void setLanguage(String language)

Defines the language (required).

Parameters:

language - the scripting language name for the script.

setSrc

public void setSrc(String fileName)

Load the script from an external file; optional.

Parameters:

fileName - the name of the file containing the script source.

addText

public void addText(String text)

Set the script text.

Parameters:

text - a component of the script text to be added.

setClasspath

public void setClasspath(Path classpath)

Set the classpath to be used when searching for classes and resources.

Parameters:

classpath - an Ant Path object containing the search path.

createClasspath

public Path createClasspath()

Classpath to be used when searching for classes and resources.

Returns:

an empty Path instance to be configured by Ant.

setClasspathRef

public void setClasspathRef(Reference r)

Set the classpath by reference.

Parameters:

r - a Reference to a Path instance to be used as the classpath value.

setSetBeans

public void setSetBeans(boolean setBeans)

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.

Parameters:

setBeans - the value to set.

setEncoding

public void setEncoding(String encoding)

Set the encoding of the script from an external file; optional.

Parameters:

encoding - the encoding of the file containing the script source.

Since:

Ant 1.10.2