Class KeySubst

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.KeySubst

All Implemented Interfaces:

Cloneable

@Deprecated
public class KeySubst
extends Task

Deprecated.

KeySubst is deprecated since Ant 1.1. Use Filter + Copy instead.

Keyword substitution. Input file is written to output file. Do not make input file same as output file. Keywords in input files look like this: @foo@. See the docs for the setKeys method to understand how to do the substitutions.

Since:

Ant 1.1

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
KeySubst()	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	execute()	Deprecated. Do the execution.
static void	main(String[] args)	Deprecated. A test method.
static String	replace(String origString, Hashtable<String,String> keys)	Deprecated. Does replacement on text using the hashtable of keys.
void	setDest(File dest)	Deprecated. Set the destination file.
void	setKeys(String keys)	Deprecated. Sets the keys.
void	setSep(String sep)	Deprecated. Sets the separator between name=value arguments in setKeys().
void	setSrc(File s)	Deprecated. Set the source file.

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

Constructor Details

KeySubst

public KeySubst()

Deprecated.

Method Details

execute

public void execute()
             throws BuildException

Deprecated.

Do the execution.

Overrides:

execute in class Task

Throws:

BuildException - on error

setSrc

public void setSrc(File s)

Deprecated.

Set the source file.

Parameters:

s - the source file

setDest

public void setDest(File dest)

Deprecated.

Set the destination file.

Parameters:

dest - the destination file

setSep

public void setSep(String sep)

Deprecated.

Sets the separator between name=value arguments in setKeys(). By default it is "*".

Parameters:

sep - the separator string

setKeys

public void setKeys(String keys)

Deprecated.

Sets the keys. Format string is like this:

name=value*name2=value

Names are case sensitive.

Use the setSep() method to change the * to something else if you need to use * as a name or value.

Parameters:

keys - a String value

main

public static void main(String[] args)

Deprecated.

A test method.

Parameters:

args - not used

replace

public static String replace(String origString,
 Hashtable<String,String> keys)
                      throws BuildException

Deprecated.

Does replacement on text using the hashtable of keys.

Parameters:

origString - an input string

keys - mapping of keys to values

Returns:

the string with the replacements in it.

Throws:

BuildException - on error