Class CopyPath

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.CopyPath

All Implemented Interfaces:

Cloneable

@Deprecated
public class CopyPath
extends Task

Deprecated.

this task should have never been released and was obsoleted by ResourceCollection support in Copy available since Ant 1.7.0. Don't use it.

Copy the contents of a path to a destination, using the mapper of choice

Since:

Ant 1.7.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_NO_DESTDIR	Deprecated. No destdir attribute
static final String	ERROR_NO_MAPPER	Deprecated. No mapper
static final String	ERROR_NO_PATH	Deprecated. No path

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

Method Summary

Modifier and Type	Method	Description
void	add(FileNameMapper newmapper)	Deprecated. add a mapper
Path	createPath()	Deprecated. Create a path.
void	execute()	Deprecated. This is a very minimal derivative of the normal copy logic.
void	setDestDir(File destDir)	Deprecated. The dest dir attribute.
void	setGranularity(long granularity)	Deprecated. Set the number of milliseconds leeway to give before deciding a target is out of date.
void	setPath(Path s)	Deprecated. Set the path to be used when running the Java class.
void	setPathRef(Reference r)	Deprecated. Set the path to use by reference.
void	setPreserveLastModified(boolean preserveLastModified)	Deprecated. Give the copied files the same last modified time as the original files.
protected void	validateAttributes()	Deprecated. Ensure we have a consistent and legal set of attributes, and set any internal flags necessary based on different combinations of attributes.

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

ERROR_NO_DESTDIR

public static final String ERROR_NO_DESTDIR

Deprecated.

No destdir attribute

See Also:

• Constant Field Values

ERROR_NO_PATH

public static final String ERROR_NO_PATH

Deprecated.

No path

See Also:

• Constant Field Values

ERROR_NO_MAPPER

public static final String ERROR_NO_MAPPER

Deprecated.

No mapper

See Also:

• Constant Field Values

Constructor Details

CopyPath

public CopyPath()

Deprecated.

Method Details

setDestDir

public void setDestDir(File destDir)

Deprecated.

The dest dir attribute.

Parameters:

destDir - the value of the destdir attribute.

add

public void add(FileNameMapper newmapper)

Deprecated.

add a mapper

Parameters:

newmapper - the mapper to add.

setPath

public void setPath(Path s)

Deprecated.

Set the path to be used when running the Java class.

Parameters:

s - an Ant Path object containing the path.

setPathRef

public void setPathRef(Reference r)

Deprecated.

Set the path to use by reference.

Parameters:

r - a reference to an existing path.

createPath

public Path createPath()

Deprecated.

Create a path.

Returns:

a path to be configured.

setGranularity

public void setGranularity(long granularity)

Deprecated.

Set the number of milliseconds leeway to give before deciding a target is out of date. TODO: This is not yet used.

Parameters:

granularity - the granularity used to decide if a target is out of date.

setPreserveLastModified

public void setPreserveLastModified(boolean preserveLastModified)

Deprecated.

Give the copied files the same last modified time as the original files.

Parameters:

preserveLastModified - if true preserve the modified time; default is false.

validateAttributes

protected void validateAttributes()
                           throws BuildException

Deprecated.

Ensure we have a consistent and legal set of attributes, and set any internal flags necessary based on different combinations of attributes.

Throws:

BuildException - if an error occurs.

execute

public void execute()
             throws BuildException

Deprecated.

This is a very minimal derivative of the normal copy logic.

Overrides:

execute in class Task

Throws:

BuildException - if something goes wrong with the build.