Class Antlib

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.Antlib

All Implemented Interfaces:

Cloneable, TaskContainer

public class Antlib
extends Task
implements TaskContainer

Antlib task. It does not occur in an ant build file. It is the root element an antlib xml file.

Since:

Ant 1.6

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TAG	The name of this task

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
Antlib()

Method Summary

Modifier and Type	Method	Description
void	addTask(Task nestedTask)	add a task to the list of tasks
static Antlib	createAntlib(Project project, URL antlibUrl, String uri)	Static method to read an ant lib definition from a url.
void	execute()	Execute the nested tasks, setting the classloader for any tasks that derive from Definer.
protected void	setClassLoader(ClassLoader classLoader)	Set the class loader for this antlib.
protected void	setURI(String uri)	Set the URI for this antlib.

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, setProject

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.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

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

Field Details

TAG

public static final String TAG

The name of this task

See Also:

• Constant Field Values

Constructor Details

Antlib

public Antlib()

Method Details

createAntlib

public static Antlib createAntlib(Project project,
 URL antlibUrl,
 String uri)

Static method to read an ant lib definition from a url.

Parameters:

project - the current project

antlibUrl - the url to read the definitions from

uri - the uri that the antlib is to be placed in

Returns:

the ant lib task

setClassLoader

protected void setClassLoader(ClassLoader classLoader)

Set the class loader for this antlib. This class loader is used for any tasks that derive from Definer.

Parameters:

classLoader - the class loader

setURI

protected void setURI(String uri)

Set the URI for this antlib.

Parameters:

uri - the namespace uri

addTask

public void addTask(Task nestedTask)

add a task to the list of tasks

Specified by:

addTask in interface TaskContainer

Parameters:

nestedTask - Nested task to execute in antlib

execute

public void execute()

Execute the nested tasks, setting the classloader for any tasks that derive from Definer.

Overrides:

execute in class Task