Class Input.Handler

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.AntlibDefinition

org.apache.tools.ant.taskdefs.DefBase

org.apache.tools.ant.taskdefs.Input.Handler

All Implemented Interfaces:

Cloneable

Enclosing class:

Input

public class Input.Handler
extends DefBase

Represents an InputHandler.

Since:

Ant 1.5

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

Method Summary

Modifier and Type	Method	Description
String	getClassname()	Get the classname of the InputHandler.
String	getRefid()	Get the refid of this Handler.
Input.HandlerType	getType()	Get the handler type.
void	setClassname(String classname)	Set the InputHandler classname.
void	setRefid(String refid)	Specify that the handler is a reference on the project; this allows the use of a custom inputhandler.
void	setType(Input.HandlerType type)	Set the handler type.

Methods inherited from class DefBase

createClasspath, createLoader, getClasspath, getClasspathId, getLoaderId, hasCpDelegate, init, isReverseLoader, setClasspath, setClasspathRef, setLoaderRef, setReverseLoader

Modifier and Type	Method	Description
Path	createClasspath()	Create the classpath to be used when searching for component being defined.
protected ClassLoader	createLoader()	create a classloader for this definition
Path	getClasspath()
String	getClasspathId()	Returns the class path id of the class path delegate.
String	getLoaderId()	Returns the loader id of the class path Delegate.
protected boolean	hasCpDelegate()	Check if classpath attributes have been set.
void	init()	Called by the project to let the task initialize properly.
boolean	isReverseLoader()
void	setClasspath(Path classpath)	Set the classpath to be used when searching for component being defined.
void	setClasspathRef(Reference r)	Set a reference to a classpath to use when loading the files.
void	setLoaderRef(Reference r)	Use the reference to locate the loader.
void	setReverseLoader(boolean reverseLoader)	Deprecated. since 1.6.x.

Methods inherited from class AntlibDefinition

getAntlibClassLoader, getURI, setAntlibClassLoader, setURI

Modifier and Type	Method	Description
ClassLoader	getAntlibClassLoader()	The current antlib classloader
String	getURI()	The URI for this definition.
void	setAntlibClassLoader(ClassLoader classLoader)	Set the class loader of the loading object
void	setURI(String uri)	The URI for this definition.

Methods inherited from class Task

bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, 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.
void	execute()	Called by the project to let the task do its work.
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.
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

Constructor Details

Handler

public Handler()

Method Details

setRefid

public void setRefid(String refid)

Specify that the handler is a reference on the project; this allows the use of a custom inputhandler.

Parameters:

refid - the String refid.

getRefid

public String getRefid()

Get the refid of this Handler.

Returns:

String refid.

setClassname

public void setClassname(String classname)

Set the InputHandler classname.

Parameters:

classname - the String classname.

getClassname

public String getClassname()

Get the classname of the InputHandler.

Returns:

String classname.

setType

public void setType(Input.HandlerType type)

Set the handler type.

Parameters:

type - a HandlerType.

getType

public Input.HandlerType getType()

Get the handler type.

Returns:

a HandlerType object.